Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
Ce guide explique comment créer un pipeline CI/CD pour tester, synchroniser et déployer des DAG dans votre environnement Cloud Composer à partir de votre dépôt GitHub.
Si vous souhaitez synchroniser uniquement les données d'autres services, consultez la section Transférer des données à partir d'autres services.
Présentation du pipeline CI/CD
![Schéma de l'architecture illustrant les étapes du flux. Le préenvoi et l'examen des demandes d'extraction se trouvent dans la section GitHub, tandis que la synchronisation du DAG et la validation manuelle du DAG se trouvent dans la section Google Cloud.](https://cloud.google.com/static/composer/docs/images/dag-cicd-integration-architecture.png?hl=fr)
Le pipeline CI/CD qui doit tester, synchroniser et déployer les DAG comporte les étapes suivantes:
Apportez une modification à un DAG, puis transférez cette modification vers une branche de développement de votre dépôt.
Vous ouvrez une demande d'extraction sur la branche principale de votre dépôt.
Cloud Build exécute des tests unitaires pour vérifier la validité de votre DAG.
Votre demande d'extraction est approuvée et fusionnée avec la branche principale de votre dépôt.
Cloud Build synchronise votre environnement de développement Cloud Composer avec ces nouvelles modifications.
Vous allez vérifier que le DAG se comporte comme prévu dans votre environnement de développement.
Si votre DAG fonctionne comme prévu, vous devez l'importer dans votre environnement de production Cloud Composer.
Objectifs
Avant de commencer
Dans ce guide, nous partons du principe que vous travaillez avec deux environnements Cloud Composer identiques: un environnement de développement et un environnement de production.
Dans le cadre de ce guide, vous ne configurez un pipeline CI/CD que pour votre environnement de développement. Vérifiez que l'environnement que vous utilisez n'est pas un environnement de production.
Dans ce guide, nous partons du principe que vos DAG et leurs tests sont stockés dans un dépôt GitHub.
L'exemple de pipeline CI/CD présente le contenu d'un exemple de dépôt. Les DAG et les tests sont stockés dans le répertoire
dags/
, avec les fichiers d'exigences, le fichier de contraintes et les fichiers de configuration Cloud Build au niveau supérieur. L'utilitaire de synchronisation des DAG et ses exigences se trouvent dans le répertoireutils
.
Créer une tâche de vérification avant envoi et des tests unitaires
La première tâche Cloud Build exécute une vérification avant envoi, qui exécute des tests unitaires pour vos DAG.
Ajouter des tests unitaires
Si vous ne l'avez pas déjà fait, créez des tests unitaires pour vos DAG. Enregistrez ces tests avec les DAG de votre dépôt, chacun avec le suffixe _test
. Par exemple, le fichier de test du DAG dans la région example_dag.py
est example_dag_test.py
. Il s'agit des tests qui s'exécutent en tant que vérification avant envoi dans votre dépôt.
Créer une configuration YAML Cloud Build pour la vérification avant envoi
Dans votre dépôt, créez un fichier YAML nommé test-dags.cloudbuild.yaml
qui configure votre tâche Cloud Build pour les vérifications avant envoi. Il comporte trois étapes:
- Installez les dépendances nécessaires à vos DAG.
- Installez les dépendances nécessaires à vos tests unitaires.
- Exécuter les tests du DAG
Créer le déclencheur Cloud Build pour la vérification avant envoi
Suivez le guide Créer des dépôts à partir de GitHub pour créer un déclencheur basé sur une application GitHub avec les configurations suivantes:
Nom :
test-dags
Événement: Demande d'extraction
Source – Dépôt: choisissez votre dépôt.
Source - Branche de base:
^main$
(remplacezmain
par le nom de la branche de base de votre dépôt, si nécessaire)Source – Contrôle des commentaires: non requis
Configuration de la compilation – Fichier de configuration Cloud Build :
/test-dags.cloudbuild.yaml
(chemin d'accès à votre fichier de compilation)
Créer un job de synchronisation des DAG et ajouter le script utilitaire des DAG
Configurez ensuite un job Cloud Build qui exécute un script utilitaire dédié aux DAG. Le script utilitaire de cette tâche synchronise vos DAG avec votre environnement Cloud Composer après leur fusion avec la branche principale de votre dépôt.
Ajouter le script de l'utilitaire des DAG
Ajoutez le script de l'utilitaire DAG à votre dépôt. Ce script utilitaire copie tous les fichiers DAG du répertoire dags/
de votre dépôt vers un répertoire temporaire, en ignorant tous les fichiers Python non DAG. Le script utilise ensuite la bibliothèque cliente Cloud Storage pour importer tous les fichiers de ce répertoire temporaire vers le répertoire dags/
du bucket de votre environnement Cloud Composer.
Créer une configuration YAML Cloud Build pour synchroniser les DAG
Dans votre dépôt, créez un fichier YAML nommé add-dags-to-composer.cloudbuild.yaml
qui configure votre tâche Cloud Build pour la synchronisation des DAG. Il comporte deux étapes:
Installez les dépendances requises par le script de l'utilitaire des DAG.
Exécutez le script utilitaire pour synchroniser les DAG de votre dépôt avec votre environnement Cloud Composer.
Créer le déclencheur Cloud Build
Suivez le guide Créer des dépôts à partir de GitHub pour créer un déclencheur basé sur une application GitHub avec les configurations suivantes:
Nom :
add-dags-to-composer
Événement: Déployer sur une branche
Source – Dépôt: choisissez votre dépôt.
Source - Branche de base:
^main$
(remplacezmain
par le nom de la branche de base de votre dépôt, si nécessaire)Source – Filtre de fichiers inclus (glob):
dags/**
Configuration de la compilation – Fichier de configuration Cloud Build :
/add-dags-to-composer.cloudbuild.yaml
(chemin d'accès à votre fichier de compilation)
Dans la configuration avancée, ajoutez deux variables de substitution:
_DAGS_DIRECTORY
: répertoire dans lequel se trouvent les DAG dans votre dépôt. Si vous utilisez l'exemple de dépôt de ce guide, il s'agit dedags/
._DAGS_BUCKET
: bucket Cloud Storage contenant le répertoiredags/
dans votre environnement Cloud Composer de développement Omettez le préfixegs://
. Par exemple,us-central1-example-env-1234ab56-bucket
.
Tester votre pipeline CI/CD
Dans cette section, vous allez suivre un flux de développement de DAG qui utilise les déclencheurs Cloud Build que vous venez de créer.
Exécuter un job de pré-envoi
Créez une demande d'extraction vers votre branche principale pour tester votre build. Recherchez votre vérification avant l'envoi sur la page. Cliquez sur Détails et sélectionnez Afficher plus d'informations sur Google Cloud Build pour afficher vos journaux de compilation dans la console Google Cloud.
![Capture d'écran d'une vérification GitHub appelée test-dags avec une flèche rouge pointant vers le nom du projet entre parenthèses](https://cloud.google.com/static/composer/docs/images/dag-cicd-integration-github-check.png?hl=fr)
Si la vérification avant l'envoi a échoué, consultez Résoudre les échecs de compilation.
Vérifier que votre DAG fonctionne dans votre environnement de développement Cloud Composer
Une fois votre demande d'extraction approuvée, fusionnez-la avec votre branche principale. Utilisez la console Google Cloud pour afficher les résultats des compilations. Si vous disposez de nombreux déclencheurs Cloud Build, vous pouvez filtrer vos compilations en fonction du nom du déclencheur add-dags-to-composer
.
Une fois la tâche de synchronisation Cloud Build réussie, le DAG synchronisé apparaît dans votre environnement Cloud Composer de développement. Vous pouvez alors vérifier que le DAG fonctionne comme prévu.
Ajouter le DAG à votre environnement de production
Une fois que le DAG fonctionne comme prévu, ajoutez-le manuellement à votre environnement de production. Pour ce faire, importez le fichier DAG dans le répertoire dags/
du bucket de votre environnement de production Cloud Composer.
Si votre tâche de synchronisation de DAG a échoué ou si votre DAG ne se comporte pas comme prévu dans votre environnement Cloud Composer de développement, consultez la section Résoudre les échecs de compilation.
Résoudre les échecs de compilation
Cette section explique comment résoudre les scénarios courants d'échec de compilation.
Que faire si la vérification avant l'envoi a échoué ?
À partir de votre demande d'extraction, cliquez sur Détails, puis sélectionnez Afficher plus d'informations sur Google Cloud Build pour afficher vos journaux de compilation dans la console Google Cloud. Ces journaux peuvent vous aider à déboguer le problème avec votre DAG. Une fois les problèmes résolus, validez la correction et déployez-la sur votre branche. La vérification avant envoi s'exécute à nouveau, et vous pouvez continuer à itérer en utilisant les journaux comme outil de débogage.
Que faire si ma tâche de synchronisation du DAG a échoué ?
Utilisez la console Google Cloud pour afficher les résultats des compilations. Si vous disposez de nombreux déclencheurs Cloud Build, vous pouvez filtrer vos compilations en fonction du nom du déclencheur add-dags-to-composer
. Examinez les journaux de la tâche de compilation et corrigez les erreurs. Si vous avez besoin d'une aide supplémentaire pour résoudre les erreurs, utilisez les canaux d'assistance.
Que faire si mon DAG ne fonctionne pas correctement dans mon environnement Cloud Composer ?
Si votre DAG ne fonctionne pas comme prévu dans votre environnement de développement Cloud Composer, ne le promouvez pas manuellement dans votre environnement Cloud Composer de production. Effectuez plutôt l'une des opérations suivantes :
- Annulez la demande d'extraction avec les modifications qui ont endommagé votre DAG pour le restaurer à l'état juste avant vos modifications (cela rétablit également tous les autres fichiers de cette demande d'extraction d'extraction).
- Créez une demande d'extraction pour annuler manuellement les modifications apportées au DAG défectueux.
- Créez une demande d'extraction pour corriger les erreurs dans votre DAG.
L'exécution de l'une de ces étapes déclenche une nouvelle vérification avant envoi et, lors de la fusion, la tâche de synchronisation du DAG.