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 un dépôt de clés.
Si vous souhaitez uniquement synchroniser les données d'autres services, consultez la section Transférer des données depuis d'autres services.
Présentation du pipeline CI/CD
Le pipeline CI/CD qui permet de tester, de synchroniser et de déployer des DAG comprend les étapes suivantes :
Vous modifiez un DAG et 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 que votre DAG est valide.
Votre demande d'extraction a été approuvée et fusionnée avec la branche principale de votre un dépôt de clés.
Cloud Build synchronise votre l'environnement Cloud Composer.
Vous vérifierez que le DAG se comporte comme prévu dans votre environnement de développement environnement.
Si votre DAG fonctionne comme prévu, vous devez l'importer dans votre environnement de production Cloud Composer.
Objectifs
Avant de commencer
Ce guide part du principe que vous travaillez avec Environnements Cloud Composer: un environnement de développement et environnement de production.
Dans le cadre de ce guide, vous ne configurez qu'un pipeline CI/CD pour votre environnement de développement. Assurez-vous 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 un dépôt de clés.
La exemple de pipeline CI/CD illustre le contenu d'un exemple de dépôt. Les DAG et les tests sont stockés dans le répertoire
dags/
, tandis que les fichiers de spécifications, le fichier de contraintes et les fichiers de configuration Cloud Build sont stockés au niveau supérieur. L'utilitaire de synchronisation des DAG et ses exigences se trouvent dans leutils
.
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 l'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 à côté des DAG de votre dépôt, chacun avec le suffixe _test
. Par exemple, le fichier de test du DAG dans example_dag.py
est example_dag_test.py
. Ce sont les
qui s'exécutent en tant que contrôle 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 job Cloud Build pour les vérifications avant envoi. On y trouve
en trois étapes:
- Installez les dépendances requises par vos DAG.
- Installez les dépendances requises par vos tests unitaires.
- Exécutez les tests du DAG.
Créer le déclencheur Cloud Build pour la vérification avant envoi
Suivez les instructions pour 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 : sélectionnez votre dépôt.
Source : branche de base :
^main$
(remplacezmain
par le nom de votre branche de base du 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 une tâche de synchronisation de DAG et ajouter un script d'utilitaire de DAG
Ensuite, configurez une tâche Cloud Build qui exécute un script d'utilitaire DAG. Le script d'utilitaire de cette tâche synchronise vos DAG avec votre environnement Cloud Composer après leur fusion dans 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 d'utilitaire copie tous les fichiers DAG du répertoire dags/
de votre dépôt dans un répertoire temporaire, en ignorant tous les fichiers Python autres que les fichiers DAG. Le script utilise ensuite la bibliothèque cliente Cloud Storage pour importer tous les fichiers de ce répertoire temporaire dans le répertoire dags/
du bucket de votre environnement Cloud Composer.
Créer une configuration YAML Cloud Build pour synchroniser des 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 d'utilitaire DAG.
Exécutez le script de l'utilitaire pour synchroniser les DAG de votre dépôt avec votre 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 : sélectionnez 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 par 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 de développement Cloud Composer. 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 vos nouvelles les déclencheurs Cloud Build créés.
Exécuter une tâche de présoumission
Créez une demande d'extraction vers votre branche principale pour tester votre build. Localisez votre sur la page. Cliquez sur Détails et sélectionnez Affichez plus d'informations sur Google Cloud Build pour consulter vos journaux de compilation dans le console Google Cloud.
Si la vérification préalable à 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 le
la console Google Cloud pour
afficher les résultats de la compilation. 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 terminée, 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
environnement. Pour ce faire,
importer le fichier DAG
vers le répertoire dags/
de votre environnement Cloud Composer de production
bucket de l'environnement.
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 d'échec de compilation courants.
Que faire si la vérification avant l'envoi a échoué ?
À partir de votre demande d'extraction, cliquez sur Détails et sélectionnez Affichez plus d'informations sur Google Cloud Build pour consulter vos journaux de compilation dans le console Google Cloud. Ces journaux peuvent vous aider à résoudre le problème lié à votre DAG. Une fois les problèmes résolus, validez la correction et déployez-la ou une autre branche. La vérification préalable à l'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 de la compilation. 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 du job de compilation et résolvez le problème
les erreurs. Si vous avez besoin d'une aide supplémentaire pour résoudre les erreurs, utilisez
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 Cloud Composer de développement, ne le promouvez pas manuellement dans votre environnement Cloud Composer de production. Effectuez plutôt l'une des opérations suivantes :
- Annulez la demande de tirage avec les modifications qui ont endommagé votre DAG pour le restaurer à l'état immédiatement antérieur à vos modifications (cela annule également tous les autres fichiers de cette demande de tirage).
- 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.
Le fait de suivre l'une de ces étapes déclenche une nouvelle vérification avant l'envoi. Lors de la fusion, le job de synchronisation du DAG.