Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1
Apache Airflow dispose d'une interface d'API REST qui vous permet d'effectuer des tâches telles que l'obtention d'informations sur les exécutions et les tâches DAG, la mise à jour des DAG, l'obtention de la configuration Airflow, l'ajout et la suppression de connexions et la création de listes d'utilisateurs.
Pour obtenir un exemple d'utilisation de l'API REST Airflow avec Cloud Run Functions, consultez la page Déclencher des DAG avec Cloud Run Functions.
Versions de l'API REST Airflow
- Airflow 2 utilise l'API REST stable.
- L'API REST expérimentale est obsolète dans Airflow.
Configurer la version stable de l'API REST Airflow
L'API REST stable est activée par défaut dans Airflow 2. Cloud Composer utilise son propre backend d'authentification d'API.
L'autorisation fonctionne de la manière standard fournie par Airflow. Lorsqu'un nouvel utilisateur accorde des autorisations via l'API, le compte de l'utilisateur obtient le rôle Op
par défaut.
Vous pouvez activer ou désactiver l'API REST stable, ou modifier le rôle utilisateur par défaut en remplaçant les options de configuration Airflow suivantes :
Section | Clé | Valeur | Remarques |
---|---|---|---|
api
|
(Airflow 2.2.5 et versions antérieures) auth_backend (Airflow 2.3.0 et versions ultérieures) auth_backends
|
airflow.composer.api.backend.composer_auth
|
Pour désactiver l'API REST stable, définissez sur airflow.api.auth.backend.deny_all . |
api
|
composer_auth_user_registration_role
|
Op
|
Vous pouvez spécifier n'importe quel autre rôle. |
Autoriser les appels d'API à l'API REST Airflow à l'aide du contrôle d'accès du serveur Web
Selon la méthode utilisée pour appeler l'API REST Airflow, la méthode de l'appelant peut utiliser une adresse IPv4 ou IPv6. N'oubliez pas de débloquer le trafic IP vers l'API REST Airflow à l'aide du contrôle des accès au serveur Web.
Utilisez l'option de configuration par défaut, qui est All IP addresses have access (default)
, si vous ne savez pas de quelle adresse IP vos appels à l'API REST Airflow seront envoyés.
Effectuer des appels vers l'API REST Airflow
Cette section fournit un exemple de script Python que vous pouvez utiliser pour déclencher des DAG avec la version stable de l'API REST Airflow.
Placez le contenu de l'exemple suivant dans un fichier nommé composer2_airflow_rest_api.py
, puis définissez les variables suivantes:
dag_id
: nom d'un DAG, tel que défini dans le fichier source du DAG.dag_config
: configuration de l'exécution du DAG.web_server_url
: URL de votre serveur Web Airflow. Il a le format suivant :https://<web-server-id>.composer.googleusercontent.com
.
Accéder à l'API REST Airflow à l'aide d'un compte de service
La base de données Airflow limite la longueur du champ d'adresse e-mail à 64 caractères. Les adresses e-mail des comptes de service sont parfois plus longues que 64 caractères. Il n'est pas possible de créer des utilisateurs Airflow pour ces comptes de service de la manière habituelle. Si aucun utilisateur Airflow n'est associé à un tel compte de service, l'accès à l'API REST Airflow génère les erreurs HTTP 401 et 403.
Pour contourner ce problème, vous pouvez préenregistrer un utilisateur Airflow pour un compte de service. Pour ce faire, utilisez accounts.google.com:NUMERIC_USER_ID
comme nom d'utilisateur et une chaîne unique comme adresse e-mail.
Pour obtenir
NUMERIC_USER_ID
pour un compte de service, exécutez la commande suivante :gcloud iam service-accounts describe \ SA_NAME@PROJECT_ID.iam.gserviceaccount.com \ --format="value(oauth2ClientId)"
Remplacez :
SA_NAME
par le nom du compte de servicePROJECT_ID
par l'ID du projet.
Créez un utilisateur Airflow doté du rôle
Op
pour le compte de service :Interface utilisateur d'Airflow
Accédez à Sécurité > Répertorier les utilisateurs, puis cliquez sur Ajouter un enregistrement. Votre utilisateur Airflow doit disposer du rôle
Admin
pour ouvrir cette page.Spécifiez
accounts.google.com:NUMERIC_USER_ID
comme nom d'utilisateur. RemplacezNUMERIC_USER_ID
par l'ID utilisateur obtenu à l'étape précédente.Spécifiez un identifiant unique comme adresse e-mail. Vous pouvez utiliser n'importe quelle chaîne unique.
Spécifiez le rôle de l'utilisateur. Par exemple,
Op
.Assurez-vous que la case Is Active? (Est-il actif ?) est cochée.
Spécifiez le prénom et le nom de l'utilisateur. Vous pouvez utiliser n'importe quelle chaîne.
Cliquez sur Enregistrer.
gcloud
Exécutez la commande de CLI Airflow suivante :
gcloud composer environments run ENVIRONMENT_NAME \ --location LOCATION \ users create -- \ -u accounts.google.com:NUMERIC_USER_ID \ -e UNIQUE_ID \ -f UNIQUE_ID \ -l - -r Op --use-random-password
Remplacez :
ENVIRONMENT_NAME
par le nom de l'environnement.LOCATION
par la région où se trouve l'environnement.NUMERIC_USER_ID
par l'ID utilisateur obtenu à l'étape précédente.UNIQUE_ID
par l'identifiant de l'utilisateur Airflow. Vous pouvez utiliser n'importe quelle chaîne unique.
Une fois que vous avez créé un utilisateur Airflow pour un compte de service, un appelant authentifié en tant que compte de service est reconnu comme utilisateur préenregistré et est connecté à Airflow.
Évoluer le composant de l'API REST Airflow
Les points de terminaison de l'API REST Airflow et de l'UI Airflow sont exécutés dans le serveur Web Airflow. Si vous utilisez l'API REST de manière intensive, envisagez d'augmenter la quantité de processeur et de mémoire disponibles pour le serveur Web Airflow, en fonction de la charge attendue.