Exécuter un DAG Apache Airflow dans Cloud Composer 2

Cloud Composer 1 | Cloud Composer 2

Ce guide de démarrage rapide explique comment créer un environnement Cloud Composer et exécuter un DAG Apache Airflow dans Cloud Composer 2.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  6. Activez l'API Cloud Composer

    Activer l'API

  7. Pour obtenir les autorisations nécessaires pour suivre ce guide de démarrage rapide, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

    Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

    Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Créez un environnement

  1. Dans la console Google Cloud, accédez à la page Créer un environnement.

    Accéder à la page "Créer un environnement"

  1. S'il s'agit du premier environnement de votre projet, la section Accorder les autorisations requises au compte de service Cloud Composer s'affiche.

    Ajoutez le compte d'agent de service Cloud Composer en tant que nouveau compte principal au compte de service de votre environnement et attribuez-lui le rôle Extension d'agent de service de l'API Cloud Composer v2.

    Vérifiez que vous utilisez le compte de service prévu pour votre environnement, puis cliquez sur Attribuer.

  2. Dans le champ Nom, saisissez example-environment.

  3. Dans la liste déroulante Emplacement, sélectionnez une région pour l'environnement Cloud Composer. Ce guide utilise la région us-central1.

  4. Pour les autres options de configuration de l'environnement, utilisez les valeurs par défaut fournies.

  5. Cliquez sur Créer et attendez que l'environnement soit créé.

  6. Une fois l'opération terminée, une coche verte s'affiche à côté du nom de l'environnement.

Créer un fichier DAG

Un DAG Airflow est un ensemble de tâches organisées que vous souhaitez planifier et exécuter. Les DAG sont définis dans des fichiers Python standards.

Ce guide utilise un exemple de DAG Airflow défini dans le fichier quickstart.py. Le code Python de ce fichier effectue les opérations suivantes:

  1. Il crée un DAG, composer_sample_dag, Ce DAG s'exécute tous les jours.
  2. Il exécute une tâche, print_dag_run_conf, qui imprime la configuration de l'exécution du DAG à l'aide de l'opérateur bash.

Enregistrez une copie du fichier quickstart.py sur votre ordinateur local:

import datetime

from airflow import models
from airflow.operators import bash

# If you are running Airflow in more than one time zone
# see https://airflow.apache.org/docs/apache-airflow/stable/timezone.html
# for best practices
YESTERDAY = datetime.datetime.now() - datetime.timedelta(days=1)

default_args = {
    "owner": "Composer Example",
    "depends_on_past": False,
    "email": [""],
    "email_on_failure": False,
    "email_on_retry": False,
    "retries": 1,
    "retry_delay": datetime.timedelta(minutes=5),
    "start_date": YESTERDAY,
}

with models.DAG(
    "composer_quickstart",
    catchup=False,
    default_args=default_args,
    schedule_interval=datetime.timedelta(days=1),
) as dag:
    # Print the dag_run id from the Airflow logs
    print_dag_run_conf = bash.BashOperator(
        task_id="print_dag_run_conf", bash_command="echo {{ dag_run.id }}"
    )

Importer le fichier DAG dans le bucket de votre environnement

Chaque environnement Cloud Composer est associé à un bucket Cloud Storage. Airflow ne programme que les DAG situés dans le dossier /dags de ce bucket.

Pour planifier votre DAG, importez quickstart.py depuis votre ordinateur local dans le dossier /dags de votre environnement:

  1. Dans la console Google Cloud, accédez à la page Environnements.

    Accéder à la page Environnements

  2. Dans la liste des environnements, cliquez sur le nom de votre environnement, example-environment. La page Détails de l'environnement s'ouvre.

  3. Cliquez sur Ouvrir le dossier des DAG. La page Informations sur le bucket s'ouvre.

  4. Cliquez sur Importer des fichiers, puis sélectionnez votre copie de quickstart.py.

  5. Pour importer le fichier, cliquez sur Ouvrir.

Afficher le DAG

Une fois le fichier DAG importé, Airflow effectue les opérations suivantes:

  1. Analyse le fichier DAG que vous avez importé. La mise à disposition du DAG pour Airflow peut prendre quelques minutes.
  2. Ajoute le DAG à la liste des DAG disponibles.
  3. Exécute le DAG selon la planification que vous avez indiquée dans le fichier DAG.

Vérifiez que votre DAG est traité sans erreur et qu'il est disponible dans Airflow en l'affichant dans l'interface utilisateur du DAG. L'UI du DAG est l'interface Cloud Composer permettant d'afficher les informations du DAG dans la console Google Cloud. Cloud Composer donne également accès à l'interface utilisateur Airflow, qui est une interface Web Airflow native.

  1. Attendez environ cinq minutes pour laisser à Airflow le temps de traiter le fichier DAG que vous avez importé précédemment et de terminer la première exécution du DAG (expliqué plus tard).

  2. Dans la console Google Cloud, accédez à la page Environnements.

    Accéder à la page Environnements

  3. Dans la liste des environnements, cliquez sur le nom de votre environnement, example-environment. La page Détails de l'environnement s'ouvre.

  4. Accédez à l'onglet DAG.

  5. Vérifiez que le DAG composer_quickstart figure dans la liste des DAG.

    La liste des DAG affiche le DAG composer_quickstart, ainsi que des informations supplémentaires telles que l'état et la programmation
    Figure 1 : La liste des DAG affiche le DAG composer_quickstart (cliquez pour agrandir)

Afficher les détails de l'exécution du DAG

Une seule exécution d'un DAG est appelée exécution DAG. Airflow exécute immédiatement une exécution du DAG pour l'exemple de DAG, car la date de début du fichier DAG est définie sur "hier". De cette manière, Airflow rattrape la programmation du DAG spécifiée.

L'exemple de DAG contient une tâche, print_dag_run_conf, qui exécute la commande echo dans la console. Cette commande génère des méta-informations sur le DAG (identifiant numérique de l'exécution du DAG).

  1. Dans l'onglet DAG, cliquez sur composer_quickstart. L'onglet Exécutions du DAG s'ouvre.

  2. Dans la liste des exécutions du DAG, cliquez sur la première entrée.

    La liste des exécutions du DAG indique l'exécution récente du DAG (sa date et son état d'exécution)
    Figure 2 : Liste des exécutions de DAG pour le DAG composer_quickstart (cliquez pour agrandir)

  3. Les détails de l'exécution du DAG s'affichent. Ils détaillent les tâches individuelles de l'exemple de DAG.

    Liste des tâches avec une entrée print_dag_run_conf, son heure de début, son heure de fin et sa durée
    Figure 3 : Liste des tâches exécutées lors de l'exécution du DAG (cliquez pour agrandir)

  4. La section Journaux de l'exécution du DAG répertorie les journaux de toutes les tâches associées à l'exécution du DAG. Vous pouvez voir le résultat de la commande echo dans les journaux.

    Entrées de journal de la tâche. L'une d'elles est "Output" (sortie) et l'autre répertorie un identifiant.
    Figure 4 : Journaux de la tâche print_dag_run_conf (cliquez pour agrandir)

Effectuer un nettoyage

Pour éviter que les ressources utilisées sur cette page soient facturées sur votre compte Google Cloud, procédez comme suit :

Supprimez les ressources utilisées dans ce tutoriel:

  1. Supprimez l'environnement Cloud Composer.

    1. Dans la console Google Cloud, accédez à la page Environnements.

      Accéder à la page Environnements

    2. Sélectionnez example-environment, puis cliquez sur Supprimer.

    3. Attendez que l'environnement soit supprimé.

  2. Supprimez le bucket de votre environnement. La suppression de l'environnement Cloud Composer ne supprime pas son bucket.

    1. Dans la console Google Cloud, accédez à la page Stockage > Navigateur.

      Accéder à Cloud Storage > Navigateur

    2. Sélectionnez le bucket de l'environnement, puis cliquez sur Supprimer. Par exemple, ce bucket peut être nommé us-central1-example-environ-c1616fe8-bucket.

  3. Supprimez le disque persistant de la file d'attente Redis de votre environnement. La suppression de l'environnement Cloud Composer ne supprime pas son disque persistant.

    1. Dans la console Google Cloud, accédez à Compute Engine > Disques.

      Accéder à la page Disques

    2. Sélectionnez le disque persistant de la file d'attente Redis de l'environnement, puis cliquez sur Supprimer.

      Par exemple, ce disque peut être nommé pvc-02bc4842-2312-4347-8519-d87bdcd31115. Les disques pour Cloud Composer 2 sont toujours du type Balanced persistent disk et d'une taille de 2 Go.

Étapes suivantes