Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
In diesem Leitfaden wird erläutert, wie Sie eine CI/CD-Pipeline erstellen, um DAGs aus Ihrem GitHub-Repository zu testen, zu synchronisieren und in Ihrer Cloud Composer-Umgebung bereitzustellen.
Wenn Sie nur Daten aus anderen Diensten synchronisieren möchten, lesen Sie Daten aus anderen Diensten übertragen
CI/CD-Pipeline – Übersicht
Die CI/CD-Pipeline zum Testen, Synchronisieren und Bereitstellen von DAGs umfasst die folgenden Schritte:
Sie nehmen eine Änderung an einem DAG vor und übertragen diese Änderung in einen Entwicklungszweig in Ihrem Repository.
Sie öffnen einen Pull-Request für den Hauptzweig Ihres Repositorys.
Cloud Build führt Einheitentests aus, um die Gültigkeit des DAG zu prüfen.
Ihre Pull-Anfrage wurde genehmigt und in den Hauptzweig Ihres Repositorys zusammengeführt.
Cloud Build synchronisiert Ihre Entwicklung Cloud Composer-Umgebung mit diesen neuen Änderungen.
Sie prüfen, ob sich der DAG in Ihrer Entwicklungsumgebung wie erwartet verhält.
Wenn Ihr DAG wie erwartet funktioniert, laden Sie ihn in die Produktion hoch. Cloud Composer-Umgebung.
Lernziele
Hinweise
In diesem Leitfaden wird davon ausgegangen, dass Sie mit zwei identischen Cloud Composer-Umgebungen: Entwicklungsumgebung und der Produktionsumgebung.
In diesem Leitfaden konfigurieren Sie eine CI/CD-Pipeline nur für Ihre Entwicklungsumgebung. Achten Sie darauf, dass die Umgebung, ist keine Produktionsumgebung.
In diesem Leitfaden wird davon ausgegangen, dass Sie Ihre DAGs und zugehörigen Tests in einem GitHub zu erstellen.
Die Beispiel für eine CI/CD-Pipeline zeigt den Inhalt eines Beispiel-Repositorys. DAGs und Tests werden im Verzeichnis
dags/
gespeichert. An der obersten Ebene befinden sich die Anforderungsdateien, die Datei mit den Einschränkungen und die Cloud Build-Konfigurationsdateien. Das Dienstprogramm für die DAG-Synchronisierung und seine Anforderungen befindet sich imutils
-Verzeichnis.
Job zur Vorabprüfung und Einheitentests erstellen
Der erste Cloud Build-Job führt eine Vorabprüfung durch, die die Einheit ausführt Tests für Ihre DAGs.
Unit-Tests hinzufügen
Erstellen Sie Einheitstests für Ihre DAGs, falls Sie das noch nicht getan haben. Speichern Sie diese Tests zusammen mit den
DAGs in Ihrem Repository, jeweils mit dem Suffix _test
. Die Testdatei für den DAG in example_dag.py
ist beispielsweise example_dag_test.py
. Dies sind die
Tests, die als Vorabprüfung in Ihrem Repository ausgeführt werden.
Cloud Build-YAML-Konfiguration für die Vorabprüfung erstellen
Erstellen Sie in Ihrem Repository eine YAML-Datei mit dem Namen test-dags.cloudbuild.yaml
, die
den Cloud Build-Job für Vorabsendeprüfungen konfiguriert. Es umfasst drei Schritte:
- Installieren Sie die Abhängigkeiten, die für Ihre DAGs erforderlich sind.
- Installieren Sie die Abhängigkeiten, die für Ihre Unit-Tests erforderlich sind.
- Führen Sie die DAG-Tests aus.
Cloud Build-Trigger für die Vorabprüfung erstellen
Folgen Sie der Anleitung unter Repositories aus GitHub erstellen. Anleitung zum Erstellen eines auf GitHub-Anwendung basierenden Triggers mit den folgenden Konfigurationen:
Name:
test-dags
Ereignis: Pull-Anfrage
Quelle: Repository: Wählen Sie Ihr Repository aus.
Quelle – Basis-Branch:
^main$
(ändern Siemain
bei Bedarf in den Namen des Basis-Branches Ihres Repositorys)Quelle – Kommentarsteuerung: nicht erforderlich
Build-Konfiguration – Cloud Build-Konfigurationsdatei:
/test-dags.cloudbuild.yaml
(Pfad zur Build-Datei)
DAG-Synchronisierungsjob erstellen und DAG-Dienstprogrammscript hinzufügen
Konfigurieren Sie als Nächstes einen Cloud Build-Job, mit dem ein DAGs-Dienstprogrammskript ausgeführt wird. Das Dienstprogramm-Script in diesem Job synchronisiert Ihre DAGs mit Ihrer Cloud Composer-Umgebung, nachdem sie mit dem Hauptzweig in Ihrem Repository zusammengeführt wurden.
DAGs-Dienstprogrammskript hinzufügen
Fügen Sie Ihrem Repository das DAG-Dienstprogrammskript hinzu. Dieses Dienstprogrammskript kopiert alle DAG-Dateien im Verzeichnis dags/
Ihres Repositorys in ein temporäres Verzeichnis und ignoriert alle Python-Dateien, die keine DAG-Dateien sind. Die
Dann verwendet das Skript die Cloud Storage-Clientbibliothek, um alle Dateien hochzuladen.
von diesem temporären Verzeichnis in das Verzeichnis dags/
in Ihrem
Bucket der Cloud Composer-Umgebung.
Cloud Build-YAML-Konfiguration zum Synchronisieren von DAGs erstellen
Erstellen Sie in Ihrem Repository eine YAML-Datei mit dem Namen add-dags-to-composer.cloudbuild.yaml
, in der Ihr Cloud Build-Job für die Synchronisierung von DAGs konfiguriert wird. Dieser enthält zwei Schritte:
Installieren Sie die Abhängigkeiten, die vom Skript des Dienstprogramms für DAGs benötigt werden.
Führen Sie das Dienstprogrammskript aus, um die DAGs in Ihrem Repository mit Ihrem Cloud Composer-Umgebung.
Cloud Build-Trigger erstellen
Folgen Sie der Anleitung unter Repositories aus GitHub erstellen, um einen GitHub App-basierten Trigger mit den folgenden Konfigurationen zu erstellen:
Name:
add-dags-to-composer
Ereignis: Per Push-Befehl an Zweig übertragen
Source (Quelle) – Repository: Wählen Sie Ihr Repository aus.
Quelle – Basiszweig:
^main$
(ändern Siemain
in den Namen Ihres Basiszweig des Repositorys (falls erforderlich)Quelle – Filter für enthaltene Dateien (glob):
dags/**
Build-Konfiguration – Cloud Build-Konfigurationsdatei:
/add-dags-to-composer.cloudbuild.yaml
(Pfad zur Build-Datei)
Fügen Sie in der erweiterten Konfiguration zwei Ersatzvariablen hinzu:
_DAGS_DIRECTORY
: das Verzeichnis, in dem sich die DAGs in Ihrem Repository befinden Wenn Sie das Beispiel-Repository aus dieser Anleitung verwenden, ist esdags/
._DAGS_BUCKET
– der Cloud Storage-Bucket, der diedags/
-Verzeichnis in Ihrer Cloud Composer-Entwicklung zu verbessern. Lassen Sie das Präfixgs://
weg. Beispiel:us-central1-example-env-1234ab56-bucket
.
CI/CD-Pipeline testen
In diesem Abschnitt führen Sie einen DAG-Entwicklungsablauf aus, bei dem Ihre neu erstellten Cloud Build-Trigger verwendet werden.
Presubmit-Job ausführen
Erstellen Sie eine Pull-Anfrage an Ihren Hauptzweig, um den Build zu testen. Finden Sie Ihren auf der Seite prüfen. Klicken Sie auf Details und wählen Sie Sehen Sie sich weitere Details zu Google Cloud Build an, um Ihre Build-Logs in der Google Cloud Console
Wenn die Prüfung vor dem Senden fehlgeschlagen ist, lesen Sie den Abschnitt Build-Fehler beheben.
Prüfen, ob der DAG in der Entwicklungsumgebung von Cloud Composer funktioniert
Nachdem Ihre Pull-Anfrage genehmigt wurde, führen Sie sie mit Ihrem Hauptzweig zusammen. Verwenden Sie die Methode
Google Cloud Console
Build-Ergebnisse ansehen. Wenn Sie viele Cloud Build-Trigger haben, können Sie Ihre Builds nach dem Triggernamen add-dags-to-composer
filtern.
Wenn der Cloud Build-Synchronisierungsjob erfolgreich war, wird der synchronisierte DAG angezeigt. in der Cloud Composer-Entwicklungsumgebung. Hier können Sie überprüfen, ob der DAG wie erwartet funktioniert.
DAG der Produktionsumgebung hinzufügen
Wenn der DAG wie erwartet funktioniert, fügen Sie ihn Ihrer Produktionsumgebung manuell hinzu. Gehen Sie dazu wie folgt vor:
DAG-Datei hochladen
in das Verzeichnis dags/
in Ihrer Cloud Composer-Produktionsumgebung
im Bucket der Umgebung.
Wenn der DAG-Synchronisierungsjob fehlgeschlagen ist oder sich der DAG in Ihrer Cloud Composer-Entwicklungsumgebung nicht wie erwartet verhält, lesen Sie den Hilfeartikel Fehler bei der Build-Ausführung beheben.
Build-Fehler beheben
In diesem Abschnitt wird beschrieben, wie Sie häufige Buildfehler beheben.
Was passiert, wenn meine Vorabprüfung fehlgeschlagen ist?
Klicken Sie in Ihrer Pull-Anfrage auf Details und wählen Sie Sehen Sie sich weitere Details zu Google Cloud Build an, um Ihre Build-Logs in der Google Cloud Console Anhand dieser Protokolle können Sie das Problem mit Ihrem DAG beheben. Nachdem Sie die Probleme behoben haben, committen Sie die Korrektur und pushen Sie sie an Ihren Branch. Die Vorabprüfung wird noch einmal ausgeführt und Sie können mithilfe der Protokolle weiter iterieren.
Was passiert, wenn mein DAG-Synchronisierungsjob fehlgeschlagen ist?
In der Google Cloud Console können Sie sich Ihre Build-Ergebnisse ansehen. Wenn Sie viele
Cloud Build-Trigger können Sie Ihre Builds nach dem Triggernamen filtern.
add-dags-to-composer
Prüfen Sie die Logs des Build-Jobs und lösen Sie den Fehler
Fehler. Wenn Sie weitere Hilfe beim Beheben der Fehler benötigen, verwenden Sie
Supportkanäle.
Was passiert, wenn mein DAG in meiner Cloud Composer-Umgebung nicht ordnungsgemäß funktioniert?
Wenn der DAG in der Entwicklung nicht wie erwartet funktioniert Cloud Composer-Umgebung, stufen Sie den DAG nicht manuell zu Ihrem in der Cloud Composer-Produktionsumgebung. Führen Sie stattdessen einen der folgenden Schritte aus:
- Pull-Anfrage wiederherstellen mit den Änderungen, durch die der DAG unterbrochen wurde, um seinen Zustand wiederherzustellen unmittelbar vor Ihren Änderungen (dadurch werden auch alle anderen Dateien in dieser Pull-Anfrage wiederhergestellt).
- Erstellen Sie eine neue Pull-Anfrage, um Änderungen am fehlerhaften DAG manuell zurückzusetzen.
- Erstellen Sie einen neuen Pull-Request, um die Fehler in Ihrem DAG zu beheben.
Wenn Sie einen dieser Schritte ausführen, wird eine neue Vorabprüfung ausgelöst. Nach der Zusammenführung den DAG-Synchronisierungsjob.