Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Gestion des dépendances Python dans requirements.txt
Cette rubrique explique comment installer et gérer les dépendances Python dans un `requirements.txt` fichier pour un environnement Amazon Managed Workflows for Apache Airflow.
**Contents**
+ [Tests DAGs à l'aide de l'utilitaire Amazon MWAA CLI](#best-practices-dependencies-cli-utility)
+ [Installation de dépendances Python à l'aide du format de fichier d'exigences PyPi .org](#best-practices-dependencies-different-ways)
+ [Option 1 : dépendances Python à partir de l'index des packages Python](#best-practices-dependencies-pip-extras)
+ [Deuxième option : roues Python (.whl)](#best-practices-dependencies-python-wheels)
+ [Utilisation du `plugins.zip` fichier dans un compartiment Amazon S3](#best-practices-dependencies-python-wheels-s3)
+ [Utilisation d'un fichier WHL hébergé sur une URL](#best-practices-dependencies-python-wheels-url)
+ [Création d'un fichier WHL à partir d'un DAG](#best-practices-dependencies-python-wheels-dag)
+ [Troisième option : dépendances Python hébergées sur un dépôt privé conforme à PyPi /PEP-503](#best-practices-dependencies-custom-auth-url)
+ [Activation des journaux sur la console Amazon MWAA](#best-practices-dependencies-troubleshooting-enable)
+ [Accès aux journaux sur la console CloudWatch Logs](#best-practices-dependencies-troubleshooting-view)
+ [Erreurs d'accès dans l'interface utilisateur d'Apache Airflow](#best-practices-dependencies-troubleshooting-aa)
+ [Connectez-vous à Apache Airflow](#airflow-access-and-login)
+ [Exemples de `requirements.txt` scénarios](#best-practices-dependencies-ex-mix-match)
## Tests DAGs à l'aide de l'utilitaire Amazon MWAA CLI
+ 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 DAGs des plugins personnalisés et des dépendances avant le déploiement sur Amazon MWAA.
+ Pour exécuter la CLI, reportez-vous à la section [aws-mwaa-docker-images](https://github.com/aws/amazon-mwaa-docker-images)on GitHub.
## Installation de dépendances Python à l'aide du format de fichier d'exigences PyPi .org
La section suivante décrit les différentes manières d'installer les dépendances Python conformément au [format de fichier d'exigences PyPi](https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format) .org.
### Option 1 : dépendances Python à partir de l'index des packages Python
La section suivante décrit comment spécifier les dépendances Python à partir de l'[index des packages Python](https://pypi.org/) dans un `requirements.txt` fichier.
------
#### [ Apache Airflow v3 ]
1. **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 à [aws-mwaa-docker-images](https://github.com/aws/amazon-mwaa-docker-images)on GitHub.
1. **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 le site Web. [aws-mwaa-docker-images `requirements.txt`](https://github.com/aws/amazon-mwaa-docker-images/blob/main/requirements.txt) GitHub
1. **Ajoutez une déclaration de contraintes**. Ajoutez le fichier de contraintes pour votre environnement Apache Airflow v3 en haut de votre fichier. `requirements.txt` Les fichiers de contraintes d'Apache Airflow spécifient les versions des fournisseurs disponibles au moment de la publication d'Apache Airflow.
Dans l'exemple suivant, remplacez *\$1environment-version\$1* par le numéro de version de votre environnement et *\$1Python-version\$1* par la version de Python compatible avec votre environnement.
Pour plus d'informations sur la version de Python compatible avec votre environnement Apache Airflow, reportez-vous à la section Versions d'[Apache Airflow](airflow-versions.md#airflow-versions-official).
```
--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êche pas l'installation de bibliothèques incompatibles dans votre environnement. Si l'installation d'un package échoue, vous pouvez accéder aux journaux d'erreurs de chaque composant Apache Airflow (le planificateur, le programme de travail et le serveur Web) dans le flux de journal correspondant sur Logs. CloudWatch Pour plus d'informations sur les types de journaux, reportez-vous à[Accès aux journaux Airflow sur Amazon CloudWatch](monitoring-airflow.md).
1. **Paquets Apache Airflow**. Ajoutez les [extras du package](http://airflow.apache.org/docs/apache-airflow/2.5.1/extra-packages-ref.html) et la version (`==`). Cela permet d'éviter que des packages portant le même nom, mais dont la version est différente, ne soient installés sur votre environnement.
```
apache-airflow[package-extra]==2.5.1
```
1. **Bibliothèques Python**. Ajoutez le nom du package et la version (`==`) dans votre `requirements.txt` fichier. Cela permet d'éviter qu'une future mise à jour de rupture de [PyPi.org](https://pypi.org) ne soit automatiquement appliquée.
```
library == version
```
**Example 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.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.](https://pypi.org) Cette version peut entrer en conflit avec les autres packages de votre`requirements.txt`.
------
#### [ Apache Airflow v2 ]
1. **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 à [aws-mwaa-docker-images](https://github.com/aws/amazon-mwaa-docker-images)on GitHub.
1. **Consultez les suppléments du package Apache Airflow**. Pour accéder à la liste des packages installés pour Apache Airflow v2 sur Amazon MWAA, rendez-vous [aws-mwaa-docker-images `requirements.txt`](https://github.com/aws/amazon-mwaa-docker-images/blob/main/requirements.txt)sur le site Web. GitHub
1. **Ajoutez une déclaration de contraintes**. Ajoutez le fichier de contraintes pour votre environnement Apache Airflow v2 en haut de votre `requirements.txt` fichier. Les fichiers de contraintes d'Apache Airflow spécifient les versions des fournisseurs disponibles au moment de la publication d'Apache Airflow.
À partir de la version 2.7.2 d'Apache Airflow, votre fichier d'exigences doit inclure une déclaration. `--constraint` Si vous ne fournissez aucune contrainte, Amazon MWAA vous en indiquera une afin de garantir 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 *\$1environment-version\$1* par le numéro de version de votre environnement et *\$1Python-version\$1* par la version de Python compatible avec votre environnement.
Pour plus d'informations sur la version de Python compatible avec votre environnement Apache Airflow, reportez-vous à la section Versions d'[Apache Airflow](airflow-versions.md#airflow-versions-official).
```
--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êche pas l'installation de bibliothèques incompatibles dans votre environnement. Si l'installation d'un package échoue, vous pouvez accéder aux journaux d'erreurs de chaque composant Apache Airflow (le planificateur, le programme de travail et le serveur Web) dans le flux de journal correspondant sur Logs. CloudWatch Pour plus d'informations sur les types de journaux, reportez-vous à[Accès aux journaux Airflow sur Amazon CloudWatch](monitoring-airflow.md).
1. **Paquets Apache Airflow**. Ajoutez les [extras du package](http://airflow.apache.org/docs/apache-airflow/2.5.1/extra-packages-ref.html) et la version (`==`). Cela permet d'éviter que des packages portant le même nom, mais dont la version est différente, ne soient installés sur votre environnement.
```
apache-airflow[package-extra]==2.5.1
```
1. **Bibliothèques Python**. Ajoutez le nom du package et la version (`==`) dans votre `requirements.txt` fichier. Cela permet d'éviter qu'une future mise à jour de rupture de [PyPi.org](https://pypi.org) ne soit automatiquement appliquée.
```
library == version
```
**Example 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.](https://pypi.org) Cette version peut entrer en conflit avec les autres packages de votre`requirements.txt`.
------
### Deuxième option : roues Python (.whl)
Une roue Python est un format de package conçu pour expédier des bibliothèques contenant des artefacts compilés. Les packages Wheel présentent plusieurs avantages en tant que méthode d'installation de dépendances dans Amazon MWAA :
+ **Installation plus rapide** : les fichiers WHL sont copiés dans le conteneur sous la forme d'un seul fichier ZIP, puis installés localement, sans qu'il soit nécessaire de les télécharger.
+ **Moins de conflits** : vous pouvez déterminer à l'avance la compatibilité des versions de vos packages. Par conséquent, il n'est pas nécessaire de trouver `pip` de manière récursive des versions compatibles.
+ **Plus de résilience** : avec les bibliothèques hébergées en externe, les exigences en aval peuvent changer, ce qui entraîne une incompatibilité des versions entre les conteneurs d'un environnement Amazon MWAA. En ne dépendant pas d'une source externe pour les dépendances, chaque conteneur possède les mêmes bibliothèques, quel que soit le moment où chaque conteneur est instancié.
Nous recommandons les méthodes suivantes pour installer les dépendances Python à partir d'une archive Python Wheel (`.whl`) dans votre`requirements.txt`.
**Topics**
+ [Utilisation du `plugins.zip` fichier dans un compartiment Amazon S3](#best-practices-dependencies-python-wheels-s3)
+ [Utilisation d'un fichier WHL hébergé sur une URL](#best-practices-dependencies-python-wheels-url)
+ [Création d'un fichier WHL à partir d'un DAG](#best-practices-dependencies-python-wheels-dag)
#### Utilisation du `plugins.zip` fichier dans un compartiment Amazon S3
Le planificateur, les outils de traitement et le serveur Web d'Apache Airflow (pour Apache Airflow v2.2.2 et versions ultérieures) recherchent des plugins personnalisés lors du démarrage sur le conteneur Fargate géré pour votre environnement à l'adresse. AWS`/usr/local/airflow/plugins/*` Ce processus commence avant Amazon MWAA `pip3 install -r requirements.txt` pour les dépendances Python et le démarrage du service Apache Airflow. Un `plugins.zip` fichier peut être utilisé pour tous les fichiers que vous ne souhaitez pas modifier en permanence pendant l'exécution de l'environnement ou pour lesquels vous ne souhaitez pas accorder l'accès aux utilisateurs qui écrivent DAGs. Par exemple, les fichiers de roue de la bibliothèque Python, les fichiers PEM de certificats et les fichiers de configuration YAML.
La section suivante décrit comment installer une roue qui se trouve dans le `plugins.zip` fichier de votre compartiment Amazon S3.
1. **Téléchargez les fichiers WHL nécessaires** Vous pouvez les utiliser [https://pip.pypa.io/en/stable/cli/pip_download/](https://pip.pypa.io/en/stable/cli/pip_download/)avec votre conteneur Amazon MWAA existant [aws-mwaa-docker-images](https://github.com/aws/amazon-mwaa-docker-images)ou `requirements.txt` sur un autre conteneur [Amazon Linux 2](https://aws.amazon.com/amazon-linux-2) pour résoudre et télécharger les fichiers Python Wheel nécessaires.
```
pip3 download -r "$AIRFLOW_HOME/dags/requirements.txt" -d "$AIRFLOW_HOME/plugins"
cd "$AIRFLOW_HOME/plugins"
zip "$AIRFLOW_HOME/plugins.zip" *
```
1. **Spécifiez le chemin dans votre `requirements.txt`**. Spécifiez le répertoire des plugins en haut de votre fichier requirements.txt en utilisant [https://pip.pypa.io/en/stable/cli/pip_install/#install-find-links](https://pip.pypa.io/en/stable/cli/pip_install/#install-find-links)et demandez de `pip` ne pas les installer à partir d'autres sources en utilisant [https://pip.pypa.io/en/stable/cli/pip_install/#install-no-index](https://pip.pypa.io/en/stable/cli/pip_install/#install-no-index), comme indiqué dans le code suivant :
```
--find-links /usr/local/airflow/plugins
--no-index
```
**Example roue dans requirements.txt**
L'exemple suivant suppose que vous avez chargé la roue dans un `plugins.zip` fichier à la racine de votre compartiment Amazon S3. Par exemple :
```
--find-links /usr/local/airflow/plugins
--no-index
numpy
```
Amazon MWAA récupère la `numpy-1.20.1-cp37-cp37m-manylinux1_x86_64.whl` roue `plugins` dans le dossier et l'installe dans votre environnement.
#### Utilisation d'un fichier WHL hébergé sur une URL
La section suivante décrit comment installer une roue hébergée sur une URL. L'URL doit être accessible au public ou accessible depuis le VPC Amazon personnalisé que vous avez spécifié pour votre environnement Amazon MWAA.
+ **Fournissez une URL**. Fournissez l'URL d'une roue dans votre`requirements.txt`.
**Example archive de roues sur une URL publique**
L'exemple suivant télécharge une roue depuis un site public.
```
--find-links https://files.pythonhosted.org/packages/
--no-index
```
Amazon MWAA récupère la roue à partir de l'URL que vous avez spécifiée et l'installe dans votre environnement.
**Note**
URLs ne sont pas accessibles à partir de serveurs Web privés, exigences d'installation dans Amazon MWAA v2.2.2 et versions ultérieures.
#### Création d'un fichier WHL à partir d'un DAG
Si vous avez un serveur Web privé utilisant Apache Airflow v2.2.2 ou version ultérieure et que vous ne parvenez pas à installer les exigences car votre environnement n'a pas accès à des référentiels externes, vous pouvez utiliser le DAG suivant pour prendre vos exigences Amazon MWAA existantes et les intégrer à Amazon S3 :
```
from airflow import DAG
from airflow.operators.bash_operator import BashOperator
from airflow.utils.dates import days_ago
S3_BUCKET = 'my-s3-bucket'
S3_KEY = 'backup/plugins_whl.zip'
with DAG(dag_id="create_whl_file", schedule_interval=None, catchup=False, start_date=days_ago(1)) as dag:
cli_command = BashOperator(
task_id="bash_command",
bash_command=f"mkdir /tmp/whls;pip3 download -r /usr/local/airflow/requirements/requirements.txt -d /tmp/whls;zip -j /tmp/plugins.zip /tmp/whls/*;aws s3 cp /tmp/plugins.zip s3://amzn-s3-demo-bucket/{S3_KEY}"
)
```
Après avoir exécuté le DAG, utilisez ce nouveau fichier comme Amazon MWAA`plugins.zip`, éventuellement, empaqueté avec d'autres plugins. Ensuite, mettez à jour votre `requirements.txt` liste précédée par `--find-links /usr/local/airflow/plugins` `--no-index` ou sans ajout`--constraint`.
Vous pouvez utiliser cette méthode pour utiliser les mêmes bibliothèques hors ligne.
### Troisième option : dépendances Python hébergées sur un dépôt privé conforme à PyPi /PEP-503
La section suivante décrit comment installer un Apache Airflow extra hébergé sur une URL privée avec authentification.
1. Ajoutez votre nom d'utilisateur et votre mot de passe comme options de [configuration d'Apache Airflow](configuring-env-variables.md). Par exemple :
+ `foo.user` : `YOUR_USER_NAME`
+ `foo.pass` : `YOUR_PASSWORD`
1. Créez votre `requirements.txt` dossier. Dans l'exemple suivant, remplacez les espaces réservés par votre URL privée, ainsi que par le nom d'utilisateur et le mot de passe que vous avez ajoutés comme options de configuration d'[Apache Airflow](configuring-env-variables.md). Par exemple :
```
--index-url https://${AIRFLOW__FOO__USER}:${AIRFLOW__FOO__PASS}@my.privatepypi.com
```
1. Ajoutez des bibliothèques supplémentaires à votre `requirements.txt` fichier. Par exemple :
```
--index-url https://${AIRFLOW__FOO__USER}:${AIRFLOW__FOO__PASS}@my.privatepypi.com
my-private-package==1.2.3
```
## Activation des journaux sur la console Amazon MWAA
Le [rôle d'exécution](mwaa-create-role.md) de votre environnement Amazon MWAA nécessite une autorisation pour envoyer des CloudWatch journaux à Logs. Pour mettre à jour les autorisations d'un rôle d'exécution, reportez-vous à[Rôle d'exécution Amazon MWAA](mwaa-create-role.md).
Vous pouvez activer les journaux Apache Airflow au niveau`INFO`, `WARNING``ERROR`, ou`CRITICAL`. Lorsque vous choisissez un niveau de journalisation, Amazon MWAA envoie des journaux correspondant à ce niveau et à tous les niveaux de gravité supérieurs. Par exemple, si vous activez les journaux au `INFO` niveau, Amazon MWAA envoie `INFO` les journaux et `WARNING` les niveaux de `CRITICAL` journalisation à CloudWatch Logs. `ERROR` Nous recommandons d'activer les journaux Apache Airflow au `INFO` niveau du planificateur afin qu'il puisse accéder aux journaux reçus pour le. `requirements.txt`
![\[Cette image montre comment activer les journaux au niveau INFO.\]](http://docs.aws.amazon.com/fr_fr/mwaa/latest/userguide/images/mwaa-console-logs-info.png)
## Accès aux journaux sur la console CloudWatch Logs
Vous pouvez accéder aux journaux d'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 accéder aux journaux Apache Airflow sur la console Logs. CloudWatch
**Pour accéder aux journaux d'un `requirements.txt`**
1. Ouvrez la page [Environnements](https://console.aws.amazon.com/mwaa/home#/environments) sur la console Amazon MWAA.
1. Choisissez un environnement.
1. **Choisissez le **groupe de journaux du planificateur Airflow** dans le volet de surveillance.**
1. Choisissez le `requirements_install_ip` **log in Log streams**.
1. Reportez-vous à 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))
```
1. 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 pouvez obtenir un message d'erreur similaire à ce qui suit :
```
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))
```
## Erreurs d'accès dans l'interface utilisateur d'Apache Airflow
Vous pouvez également vérifier l'interface utilisateur d'Apache Airflow pour déterminer si une erreur est liée à un autre problème. L'erreur la plus courante que vous pouvez rencontrer avec Apache Airflow sur Amazon MWAA est la suivante :
```
Broken DAG: No module named x
```
Si vous trouvez cette erreur dans l'interface utilisateur d'Apache Airflow, il vous manque probablement une dépendance requise dans votre `requirements.txt` fichier.
### Connectez-vous à Apache Airflow
Vous avez besoin d'[Politique d'accès à l'interface utilisateur d'Apache Airflow : Amazon MWAAWeb ServerAccess](access-policies.md#web-ui-access)autorisations pour que votre Compte AWS identifiant Gestion des identités et des accès AWS (IAM) puisse accéder à votre interface utilisateur Apache Airflow.
**Pour accéder à votre interface utilisateur Apache Airflow**
1. Ouvrez la page [Environnements](https://console.aws.amazon.com/mwaa/home#/environments) sur la console Amazon MWAA.
1. Choisissez un environnement.
1. Choisissez **Open Airflow UI**.
## Exemples de `requirements.txt` scénarios
Vous pouvez mélanger et assortir différents formats dans votre`requirements.txt`. L'exemple suivant utilise une combinaison des différentes méthodes pour installer des options supplémentaires.
**Example Des suppléments sur PyPi .org et une URL publique**
Vous devez utiliser `--index-url` cette option lorsque vous spécifiez des packages provenant de PyPi .org, en plus des packages sur une URL publique, tels que le dépôt URLs personnalisé conforme à la norme PEP 503.
```
aws-batch == 0.6
phoenix-letter >= 0.3
--index-url http://dist.repoze.org/zope2/2.10/simple
zopelib
```