Conditions préalables Comment ça marche Vue d'ensemble des dépendances Python Création d'un fichier requirements.txt Chargement du fichier requirements.txt sur Amazon S3 Installation des dépendances Python dans votre environnement Accès aux journaux de votre fichier requirements.txt Quelle est la prochaine étape ?

Installation des dépendances Python

Une dépendance Python est un package ou une distribution non inclus dans l'installation de base d'Apache Airflow pour votre version d'Apache Airflow sur votre environnement Amazon Managed Workflows pour Apache Airflow. Cette rubrique décrit les étapes à suivre pour installer les dépendances Python d'Apache Airflow dans votre environnement Amazon MWAA à l'aide d'un requirements.txt fichier de votre compartiment Amazon S3.

Table des matières

Conditions préalables

Vous aurez besoin des éléments suivants avant de pouvoir effectuer les étapes de cette page.

Autorisations : votre administrateur Compte AWS doit vous avoir accordé l'accès à la politique de contrôle AmazonMWAAFullConsoleAccess d'accès de votre environnement. En outre, votre environnement Amazon MWAA doit être autorisé par votre rôle d'exécution à accéder aux AWS ressources utilisées par votre environnement.
Accès : si vous avez besoin d'accéder à des référentiels publics pour installer des dépendances directement sur le serveur Web, votre environnement doit être configuré avec un accès au serveur Web du réseau public. Pour plus d’informations, consultez Modes d’accès Apache Airflow.
Configuration Amazon S3 : le compartiment Amazon S3 utilisé pour stocker vos DAG, vos plugins personnalisés et vos dépendances Python dans plugins.zip requirements.txt doit être configuré avec l'accès public bloqué et la gestion des versions activée.

Comment ça marche

Sur Amazon MWAA, vous installez toutes les dépendances Python en chargeant un requirements.txt fichier dans votre compartiment Amazon S3, puis en spécifiant la version du fichier sur la console Amazon MWAA chaque fois que vous mettez à jour le fichier. Amazon MWAA s'exécute pip3 install -r requirements.txt pour installer les dépendances Python sur le planificateur Apache Airflow et sur chacun des workers.

Pour exécuter des dépendances Python sur votre environnement, vous devez effectuer trois opérations :

Créez un requirements.txt fichier localement.
Téléchargez le fichier local requirements.txt dans votre compartiment Amazon S3.
Spécifiez la version de ce fichier dans le champ Fichier des exigences de la console Amazon MWAA.

Note

Si c'est la première fois que vous créez et chargez un requirements.txt fichier dans votre compartiment Amazon S3, vous devez également spécifier le chemin d'accès au fichier sur la console Amazon MWAA. Vous ne devez effectuer cette étape qu'une seule fois.

Vue d'ensemble des dépendances Python

Vous pouvez installer les extras d'Apache Airflow et d'autres dépendances Python à partir du Python Package Index (PyPi.org), des roues Python (.whl) ou des dépendances Python hébergées sur un dépôt PyPi/PEP-503 conforme privé de votre environnement.

Limites d'emplacement et de taille des dépendances Python

Le planificateur Apache Airflow et les workers recherchent les packages dans le requirements.txt fichier et les packages sont installés dans l'environnement à l'adresse. /usr/local/airflow/.local/bin

Limite de taille. Nous recommandons un requirements.txt fichier qui fait référence à des bibliothèques dont la taille combinée est inférieure à 1 Go. Plus Amazon MWAA doit installer de bibliothèques, plus le temps de démarrage d'un environnement est long. Bien qu'Amazon MWAA ne limite pas explicitement la taille des bibliothèques installées, si les dépendances ne peuvent pas être installées dans les dix minutes, le service Fargate expirera et tentera de rétablir la stabilité de l'environnement.

Création d'un fichier requirements.txt

Les étapes suivantes décrivent les étapes que nous recommandons pour créer un fichier requirements.txt localement.

Première étape : tester les dépendances Python à l'aide de l'utilitaire CLI Amazon MWAA

L'utilitaire d'interface de ligne de commande (CLI) reproduit localement un environnement Amazon Managed Workflows pour Apache Airflow.
La CLI crée localement une image de conteneur Docker similaire à une image de production Amazon MWAA. Vous pouvez l'utiliser pour exécuter un environnement Apache Airflow local afin de développer et de tester des DAG, des plugins personnalisés et des dépendances avant le déploiement sur Amazon MWAA.
Pour exécuter la CLI, reportez-vous à https://github.com/aws/amazon-mwaa-docker-images aws-mwaa-docker-images on. GitHub

Deuxième étape : créer le `fichier requirements.txt`

La section suivante explique comment spécifier les dépendances Python à partir de l'index des packages Python dans un requirements.txt fichier.

Apache Airflow v3

Testez localement. Ajoutez des bibliothèques supplémentaires de manière itérative pour trouver la bonne combinaison de packages et de leurs versions, avant de créer un requirements.txt fichier. Pour exécuter l'utilitaire Amazon MWAA CLI, reportez-vous à la section https://github.com/aws/amazon-mwaa-docker-images aws-mwaa-docker-images sur. GitHub
Consultez les suppléments du package Apache Airflow. Pour accéder à la liste des packages installés pour Apache Airflow v3 sur Amazon MWAA, consultez requirements.txt aws-mwaa-docker-images sur le site Web. GitHub
Ajoutez une déclaration de contraintes. Ajoutez le fichier de contraintes de votre environnement Apache Airflow v3 en haut de votre requirements.txt fichier. Les fichiers de contraintes d'Apache Airflow spécifient les versions du fournisseur disponibles au moment de la publication d'Apache Airflow.

Dans l'exemple suivant, remplacez-la {Airflow-version} par la version Airflow de votre environnement. {Python-version}Remplacez-la par la version de Python compatible avec votre environnement.

Pour plus d'informations sur la version de Python compatible avec votre environnement Apache Airflow, consultez la section Versions d'Apache Airflow.
```
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-{Airflow-version}/constraints-{Python-version}.txt"
```
Si le fichier de contraintes détermine que le xyz==1.0 package n'est pas compatible avec les autres packages de votre environnement, pip3 install il n'empêchera pas l'installation de bibliothèques incompatibles dans votre environnement. Si l'installation échoue pour l'un des packages, vous pouvez accéder aux journaux d'erreurs pour chaque composant Apache Airflow (le planificateur, le worker et le serveur Web) dans le flux de journaux correspondant sur Logs. CloudWatch Pour plus d'informations sur les types de journaux, reportez-vous àAccès aux journaux Airflow sur Amazon CloudWatch.

Mise à jour des versions des fichiers de contraintes
Si vous devez mettre à jour les versions du fichier de contraintes, reportez-vous à la section Fichier de contraintes.
Packages Apache Airflow. Ajoutez les extras du package et la version (==). Cela permet d'empêcher l'installation de packages portant le même nom, mais dont la version est différente, dans votre environnement.
```
apache-airflow[package-extra]==3.2.1
```
Bibliothèques Python. Ajoutez le nom du package et la version (==) dans votre requirements.txt fichier. Cela permet d'éviter l'application automatique d'une future mise à jour PyPi.org de dernière minute.
```
library == version
```
Exemple Boto3 et psycopg2-binary
Cet exemple est fourni à des fins de démonstration. Les bibliothèques boto et psycopg2-binary sont incluses dans l'installation de base d'Apache Airflow v3 et n'ont pas besoin d'être spécifiées dans un fichier. requirements.txt
```
boto3==1.42.84
botocore==1.42.84
psycopg2-binary==2.9.11
```
Si un package est spécifié sans version, Amazon MWAA installe la dernière version du package depuis. PyPi.org Cette version peut entrer en conflit avec d'autres packages de votrerequirements.txt.

Apache Airflow v2

Testez localement. Ajoutez des bibliothèques supplémentaires de manière itérative pour trouver la bonne combinaison de packages et de leurs versions, avant de créer un requirements.txt fichier. Pour exécuter l'utilitaire Amazon MWAA CLI, reportez-vous à la section https://github.com/aws/amazon-mwaa-docker-images aws-mwaa-docker-images sur. GitHub
Consultez les suppléments du package Apache Airflow. Pour accéder à la liste des packages installés pour Apache Airflow v2 sur Amazon MWAA, accédez à requirements.txt aws-mwaa-docker-images sur le site Web. GitHub
Ajoutez une déclaration de contraintes. Ajoutez le fichier de contraintes de votre environnement Apache Airflow v2 en haut de votre requirements.txt fichier. Les fichiers de contraintes d'Apache Airflow spécifient les versions du fournisseur disponibles au moment de la publication d'Apache Airflow.

À partir de la version 2.7.2 d'Apache Airflow, votre fichier de spécifications doit inclure une déclaration. --constraint Si vous n'indiquez aucune contrainte, Amazon MWAA vous en indiquera une afin de s'assurer que les packages répertoriés dans vos exigences sont compatibles avec la version d'Apache Airflow que vous utilisez.

Dans l'exemple suivant, remplacez-la {Airflow-version} par la version Airflow de votre environnement. {Python-version}Remplacez-la par la version de Python compatible avec votre environnement.

Pour plus d'informations sur la version de Python compatible avec votre environnement Apache Airflow, consultez la section Versions d'Apache Airflow.
```
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-{Airflow-version}/constraints-{Python-version}.txt"
```
Si le fichier de contraintes détermine que le xyz==1.0 package n'est pas compatible avec les autres packages de votre environnement, pip3 install il n'empêchera pas l'installation de bibliothèques incompatibles dans votre environnement. Si l'installation échoue pour l'un des packages, vous pouvez accéder aux journaux d'erreurs pour chaque composant Apache Airflow (le planificateur, le worker et le serveur Web) dans le flux de journaux correspondant sur Logs. CloudWatch Pour plus d'informations sur les types de journaux, reportez-vous àAccès aux journaux Airflow sur Amazon CloudWatch.

Mise à jour des versions des fichiers de contraintes
Si vous devez mettre à jour les versions du fichier de contraintes, reportez-vous à la section Fichier de contraintes.
Packages Apache Airflow. Ajoutez les extras du package et la version (==). Cela permet d'empêcher l'installation de packages portant le même nom, mais dont la version est différente, dans votre environnement.
```
apache-airflow[package-extra]==2.5.1
```
Bibliothèques Python. Ajoutez le nom du package et la version (==) dans votre requirements.txt fichier. Cela permet d'éviter l'application automatique d'une future mise à jour PyPi.org de dernière minute.
```
library == version
```
Exemple Boto3 et psycopg2-binary
Cet exemple est fourni à des fins de démonstration. Les bibliothèques boto et psycopg2-binary sont incluses dans l'installation de base d'Apache Airflow v2 et n'ont pas besoin d'être spécifiées dans un fichier. requirements.txt
```
boto3==1.17.54
boto==2.49.0
botocore==1.20.54
psycopg2-binary==2.8.6
```
Si un package est spécifié sans version, Amazon MWAA installe la dernière version du package depuis. PyPi.org Cette version peut entrer en conflit avec d'autres packages de votrerequirements.txt.

Chargement du `fichier requirements.txt` sur Amazon S3

Vous pouvez utiliser la console Amazon S3 ou le AWS Command Line Interface (AWS CLI) pour charger un requirements.txt fichier dans votre compartiment Amazon S3.

Utilisation de AWS CLI

Le AWS Command Line Interface (AWS CLI) est un outil open source que vous pouvez utiliser pour interagir avec les AWS services à l'aide des commandes de votre shell de ligne de commande. Pour effectuer les étapes de cette page, vous devez disposer des éléments suivants :

Pour télécharger à l'aide du AWS CLI

Utilisez la commande suivante pour répertorier tous vos compartiments Amazon S3.
```
aws s3 ls
```
Utilisez la commande suivante pour répertorier les fichiers et les dossiers du compartiment Amazon S3 correspondant à votre environnement.
```
aws s3 ls s3://YOUR_S3_BUCKET_NAME
```
La commande suivante télécharge un requirements.txt fichier vers un compartiment Amazon S3.
```
aws s3 cp requirements.txt s3://amzn-s3-demo-bucket/requirements.txt
```

Utilisation de la console Amazon S3

La console Amazon S3 est une interface utilisateur Web que vous pouvez utiliser pour créer et gérer les ressources de votre compartiment Amazon S3.

Pour charger à l'aide de la console Amazon S3

Ouvrez la page Environnements sur la console Amazon MWAA.
Choisissez un environnement.
Sélectionnez le lien vers le compartiment S3 dans le code DAG du volet S3 pour ouvrir votre compartiment de stockage dans la console.
Choisissez Charger.
Choisissez Ajouter un fichier.
Sélectionnez la copie locale de votrerequirements.txt, puis choisissez Télécharger.

Installation des dépendances Python dans votre environnement

Cette section explique comment installer les dépendances que vous avez chargées dans votre compartiment Amazon S3 en spécifiant le chemin d'accès au fichier requirements.txt et en spécifiant la version du fichier requirements.txt à chaque fois qu'il est mis à jour.

Spécifier le chemin d'accès au `fichier requirements.txt` sur la console Amazon MWAA (la première fois)

Ouvrez la page Environnements sur la console Amazon MWAA.
Choisissez un environnement.
Choisissez Modifier.
Dans le volet Code DAG d'Amazon S3, choisissez Browse S3 à côté du champ Requirements file - facultatif.
Sélectionnez le requirements.txt fichier dans votre compartiment Amazon S3.
Choisissez Choisir.
Choisissez Suivant, Mettre à jour l'environnement.

Vous pouvez commencer à utiliser les nouveaux packages immédiatement après la fin de la mise à jour de votre environnement.

Spécification de la `version de` requirements.txt sur la console Amazon MWAA

Vous devez spécifier la version de votre requirements.txt fichier sur la console Amazon MWAA chaque fois que vous chargez une nouvelle version de votre fichier requirements.txt dans votre compartiment Amazon S3.

Ouvrez la page Environnements sur la console Amazon MWAA.
Choisissez un environnement.
Choisissez Modifier.
Dans le volet Code DAG d'Amazon S3, choisissez une requirements.txt version dans la liste déroulante.
Choisissez Suivant, Mettre à jour l'environnement.

Vous pouvez commencer à utiliser les nouveaux packages immédiatement après la fin de la mise à jour de votre environnement.

Accès aux journaux de votre `fichier requirements.txt`

Vous pouvez consulter les journaux Apache Airflow pour le planificateur qui planifie vos flux de travail et analyse votre dossier. dags Les étapes suivantes décrivent comment ouvrir le groupe de journaux pour le planificateur sur la console Amazon MWAA et comment accéder aux journaux Apache Airflow sur la CloudWatch console Logs.

Pour accéder aux journaux d'un `fichier requirements.txt`

Ouvrez la page Environnements sur la console Amazon MWAA.
Choisissez un environnement.
Choisissez le groupe de journaux du planificateur Airflow dans le volet Surveillance.
Choisissez l'option requirements_install_ip Login Log streams.

Consultez la liste des packages installés sur l'environnement à l'adresse/usr/local/airflow/.local/bin. Par exemple :


Collecting appdirs==1.4.4 (from -r /usr/local/airflow/.local/bin (line 1))
Downloading https://files.pythonhosted.org/packages/3b/00/2344469e2084fb28kjdsfiuyweb47389789vxbmnbjhsdgf5463acd6cf5e3db69324/appdirs-1.4.4-py2.py3-none-any.whl  
Collecting astroid==2.4.2 (from -r /usr/local/airflow/.local/bin (line 2))

Consultez la liste des packages et vérifiez si l'un d'entre eux a rencontré une erreur lors de l'installation. En cas de problème, vous obtenez une erreur similaire à la suivante :


2021-03-05T14:34:42.731-07:00
No matching distribution found for LibraryName==1.0.0 (from -r /usr/local/airflow/.local/bin (line 4))
No matching distribution found for LibraryName==1.0.0 (from -r /usr/local/airflow/.local/bin (line 4))

Quelle est la prochaine étape ?

Testez vos DAG, vos plugins personnalisés et vos dépendances Python localement à l'aide de https://github.com/aws/amazon-mwaa-docker-images aws-mwaa-docker-images activé. GitHub

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Installation de plugins personnalisés

Suppression de fichiers sur Amazon S3