DAGs über GitHub testen, synchronisieren und bereitstellen

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Hinweis: Diese Seite wurde für Cloud Composer 3 noch nicht überarbeitet und zeigt Inhalte für Cloud Composer 2.

In diesem Leitfaden wird erläutert, wie Sie eine CI/CD-Pipeline zum Testen, Synchronisieren und DAGs über GitHub in Ihrer Cloud Composer-Umgebung bereitstellen zu erstellen.

Wenn Sie nur Daten aus anderen Diensten synchronisieren möchten, lesen Sie Daten aus anderen Diensten übertragen

CI/CD-Pipeline – Übersicht

Abbildung 1. Architekturdiagramm, das die Schritte des Datenflusses zeigt (zum Vergrößern klicken)

Die CI/CD-Pipeline zum Testen, Synchronisieren und Bereitstellen von DAGs verfügt über folgenden Schritten:

1. Sie nehmen eine Änderung an einem DAG vor und übertragen diese Änderung in einen Entwicklungszweig in Ihrem Repository gespeichert.

2. Sie öffnen eine Pull-Anfrage für den Hauptzweig Ihres Repositorys.

3. Cloud Build führt Einheitentests aus, um die Gültigkeit des DAG zu prüfen.

4. Ihre Pull-Anfrage wurde genehmigt und mit dem Hauptzweig Ihres zu erstellen.

5. Cloud Build synchronisiert Ihre Entwicklung Cloud Composer-Umgebung mit diesen neuen Änderungen.

6. Sie prüfen, ob sich der DAG in der Entwicklung wie erwartet verhält. zu verbessern.

7. Wenn Ihr DAG wie erwartet funktioniert, laden Sie ihn in die Produktion hoch. Cloud Composer-Umgebung.

Lernziele

Ziel:

• Führen Sie mit Cloud Build eine automatisierte Vorabprüfung aus. Diese Prüfung wird ausgeführt Einheitentests für einen DAG.
• DAGs in der Cloud Composer-Entwicklungsumgebung synchronisieren mit DAGs in Ihrem GitHub-Repository.

Hinweise

• In diesem Leitfaden wird davon ausgegangen, dass Sie mit zwei identischen Cloud Composer-Umgebungen: Entwicklungsumgebung und der Produktionsumgebung.

  Für die Zwecke dieser Anleitung konfigurieren Sie nur eine CI/CD-Pipeline. 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 sind mit Anforderungsdateien, die im Verzeichnis dags/ gespeichert sind, und Cloud Build-Konfigurationsdateien, die auf oberster Ebene gespeichert sind. Das Dienstprogramm für die DAG-Synchronisierung und seine Anforderungen befindet sich im utils-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.

Einheitentests hinzufügen

Falls noch nicht geschehen, erstellen Sie Einheitentests für Ihre DAGs. Speichern Sie diese Tests zusammen mit den DAGs in Ihrem Repository, jeweils mit dem Suffix _test. Der Test für den DAG in example_dag.py ist 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. Darin befinden sich drei Schritte:

1. Installieren Sie die Abhängigkeiten, die für Ihre DAGs erforderlich sind.
2. Installieren Sie die Abhängigkeiten, die für Ihre Einheitentests erforderlich sind.
3. Führen Sie die DAG-Tests aus.

steps:
  # install dependencies
  - name: python:3.8-slim
    entrypoint: pip
    args: ["install", "-r", "requirements.txt", "-c", "constraints.txt", "--user"]

  - name: python:3.8-slim
    entrypoint: pip
    args: ["install", "-r", "requirements-test.txt", "--user"]

  # run in python 3.8 which is latest version in Cloud Composer
  - name: python:3.8-slim
    entrypoint: python3.8
    args: ["-m", "pytest", "-s", "dags/"]

Hinweis: Cloud Build ruft das Python-Image aus Docker Hub ab und Sie können geben Sie das Tag in das Feld name jedes Schritts. Wenn du python als entrypoint verwendest, Ihre entrypoint muss mit der im Tag angegebenen Version übereinstimmen. Andernfalls ist entrypoint standardmäßig auf latest gesetzt.

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 – Basiszweig: ^main$ (ändern Sie main in den Namen Ihres Basiszweig des Repositorys (falls erforderlich)

• Quelle – Kommentarsteuerung: nicht erforderlich

  Achtung :Wenn Sie die Kommentarsteuerung als nicht erforderlich festlegen, kann eine Pull-Anfrage senden, die den Build auslöst. Für größere Repositories oder Repositories mit nicht vertrauenswürdigen Mitwirkenden enthalten, ist die Kommentarsteuerung erforderlich, wird empfohlen.

• Build-Konfiguration – Cloud Build-Konfigurationsdatei: /test-dags.cloudbuild.yaml (Pfad zur Build-Datei)

DAG-Synchronisierungsjob erstellen und Dienstprogrammskript für DAGs hinzufügen

Konfigurieren Sie als Nächstes einen Cloud Build-Job, mit dem ein DAGs-Dienstprogrammskript ausgeführt wird. Die synchronisiert Ihre DAGs mit Ihrem Dienstprogrammskript Cloud Composer-Umgebung, nachdem sie mit dem Hauptzweig zusammengeführt wurden in Ihrem Repository gespeichert.

Hinweis: Cloud Composer parst alle DAGs in einem wiederholten Intervall. Dieses selbst wenn sich DAGs seit dem letzten Parsen nicht geändert haben. Aus diesem Grund lädt dieses Dienstprogramm alle DAGs in Cloud Composer hoch, nicht nur die sich geändert haben.

DAGs-Dienstprogrammskript hinzufügen

Fügen Sie Ihrem Repository das DAG-Dienstprogrammskript hinzu. Dieses Dienstprogrammskript kopiert alle DAG-Dateien im Verzeichnis dags/ Ihres Repository in einem temporären Verzeichnis und ignoriert alle Nicht-DAG-Python-Dateien. 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.

from __future__ import annotations

import argparse
import glob
import os
from shutil import copytree, ignore_patterns
import tempfile

# Imports the Google Cloud client library
from google.cloud import storage


def _create_dags_list(dags_directory: str) -> tuple[str, list[str]]:
    temp_dir = tempfile.mkdtemp()

    # ignore non-DAG Python files
    files_to_ignore = ignore_patterns("__init__.py", "*_test.py")

    # Copy everything but the ignored files to a temp directory
    copytree(dags_directory, f"{temp_dir}/", ignore=files_to_ignore, dirs_exist_ok=True)

    # The only Python files left in our temp directory are DAG files
    # so we can exclude all non Python files
    dags = glob.glob(f"{temp_dir}/*.py")
    return (temp_dir, dags)


def upload_dags_to_composer(
    dags_directory: str, bucket_name: str, name_replacement: str = "dags/"
) -> None:
    """
    Given a directory, this function moves all DAG files from that directory
    to a temporary directory, then uploads all contents of the temporary directory
    to a given cloud storage bucket
    Args:
        dags_directory (str): a fully qualified path to a directory that contains a "dags/" subdirectory
        bucket_name (str): the GCS bucket of the Cloud Composer environment to upload DAGs to
        name_replacement (str, optional): the name of the "dags/" subdirectory that will be used when constructing the temporary directory path name Defaults to "dags/".
    """
    temp_dir, dags = _create_dags_list(dags_directory)

    if len(dags) > 0:
        # Note - the GCS client library does not currently support batch requests on uploads
        # if you have a large number of files, consider using
        # the Python subprocess module to run gsutil -m cp -r on your dags
        # See https://cloud.google.com/storage/docs/gsutil/commands/cp for more info
        storage_client = storage.Client()
        bucket = storage_client.bucket(bucket_name)

        for dag in dags:
            # Remove path to temp dir
            dag = dag.replace(f"{temp_dir}/", name_replacement)

            try:
                # Upload to your bucket
                blob = bucket.blob(dag)
                blob.upload_from_filename(dag)
                print(f"File {dag} uploaded to {bucket_name}/{dag}.")
            except FileNotFoundError:
                current_directory = os.listdir()
                print(
                    f"{name_replacement} directory not found in {current_directory}, you may need to override the default value of name_replacement to point to a relative directory"
                )
                raise

    else:
        print("No DAGs to upload.")


if __name__ == "__main__":
    parser = argparse.ArgumentParser(
        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
    )
    parser.add_argument(
        "--dags_directory",
        help="Relative path to the source directory containing your DAGs",
    )
    parser.add_argument(
        "--dags_bucket",
        help="Name of the DAGs bucket of your Composer environment without the gs:// prefix",
    )

    args = parser.parse_args()

    upload_dags_to_composer(args.dags_directory, args.dags_bucket)

YAML-Konfiguration für Cloud Build zum Synchronisieren von DAGs erstellen

Erstellen Sie in Ihrem Repository eine YAML-Datei mit dem Namen add-dags-to-composer.cloudbuild.yaml, der Cloud Build konfiguriert zum Synchronisieren von DAGs. Dieser enthält zwei Schritte:

1. Installieren Sie die Abhängigkeiten, die vom Skript des Dienstprogramms für DAGs benötigt werden.

2. Führen Sie das Dienstprogrammskript aus, um die DAGs in Ihrem Repository mit Ihrem Cloud Composer-Umgebung.

steps:
  # install dependencies
  - name: python
    entrypoint: pip
    args: ["install", "-r", "utils/requirements.txt", "--user"]

  # run
  - name: python
    entrypoint: python
    args: ["utils/add_dags_to_composer.py", "--dags_directory=${_DAGS_DIRECTORY}", "--dags_bucket=${_DAGS_BUCKET}"]

Hinweis: Cloud Build ruft das Python-Image aus Docker Hub ab und Sie können geben Sie das Tag in das Feld name jedes Schritts. Wenn du python als entrypoint verwendest, Ihre entrypoint muss mit der im Tag angegebenen Version übereinstimmen. Andernfalls ist entrypoint standardmäßig auf latest gesetzt.

Cloud Build-Trigger erstellen

Folgen Sie der Anleitung unter Repositories aus GitHub erstellen. Anleitung zum Erstellen eines auf GitHub-Anwendung basierenden Triggers mit den folgenden Konfigurationen:

• Name: add-dags-to-composer

• Ereignis: Push zu einem Zweig

• Quelle: Repository: Wählen Sie Ihr Repository aus.

• Quelle – Basiszweig: ^main$ (ändern Sie main 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 Substitutionsvariablen:

• _DAGS_DIRECTORY ist das Verzeichnis, in dem sich „dags“ in Ihrem Repository befindet. Wenn Sie das Beispiel-Repository aus dieser Anleitung verwenden, ist es dags/.

• _DAGS_BUCKET – der Cloud Storage-Bucket, der die dags/-Verzeichnis in Ihrer Cloud Composer-Entwicklung zu verbessern. Lassen Sie das Präfix gs:// weg. Beispiel: us-central1-example-env-1234ab56-bucket.

Achtung: Wenn Sie das Suffix dags/ nicht aus Cloud Storage entfernen Bucket-Name in der Ersatzvariablen _DAGS_BUCKET, dem DAG-Synchronisierungsjob schlägt mit dem Fehler NotFound fehl. Das liegt daran, dass in Cloud Storage dags/ ist ein Ordner, der als Teil des Objektnamens, der nicht Teil des Bucket-Namens ist.

CI/CD-Pipeline testen

Folgen Sie in diesem Abschnitt einem DAG-Entwicklungsablauf, der Ihre neuen Cloud Build-Trigger erstellt.

Vorabsendejob 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

Wichtig: Cloud Build führt Einheitentests mit Paketen aus, die in requirements.txt und requirements-test.txt, einschließlich einer öffentlichen Version von Airflow. Ihre Cloud Composer-Umgebung hat möglicherweise ein anderes PyPI-Paketen und vorinstallierte Pakete. Wir empfehlen, eine lokale Airflow-Umgebung ausführen, während Sie Ihre DAGs.

<ph type="x-smartling-placeholder">

</ph>

Abbildung 2: Screenshot des Cloud Build-Vorabprüfungsstatus auf GitHub (zum Vergrößern klicken)

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 können Sie Ihre Builds nach dem Triggernamen filtern. add-dags-to-composer

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

Nachdem der DAG wie erwartet funktioniert, fügen Sie ihn manuell der Produktion hinzu zu verbessern. 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 der DAG in Ihrem Entwicklungsumgebung von Cloud Composer, siehe Build-Fehler beheben

Build-Fehler beheben

In diesem Abschnitt wird erläutert, wie Sie häufige Build-Fehlerszenarien 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 Verwenden Sie diese Protokolle, um das Problem mit Ihrem DAG Sobald Sie die Probleme behoben haben, führen Sie die Fehlerbehebung durch und senden Sie sie an Ihr Branch. Die Prüfung vor dem Senden wird noch einmal ausgeführt. Logs als Debugging-Tool einsetzen.

Was passiert, wenn mein DAG-Synchronisierungsjob fehlgeschlagen ist?

Verwenden Sie die Google Cloud Console für Folgendes: 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 beim Beheben der Fehler weitere Hilfe benötigen, nutzen 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, die den DAG unterbrochen haben, um den 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 eine neue Pull-Anfrage, um die Fehler im DAG zu beheben.

Wenn Sie einen dieser Schritte ausführen, wird eine neue Vorabprüfung ausgelöst. Nach der Zusammenführung den DAG-Synchronisierungsjob.

Nächste Schritte

• Lokale Airflow-Umgebungen ausführen
• DAGs schreiben
• DAGs auslösen
• DAGs testen