Testare, sincronizzare ed eseguire il deployment dei DAG da GitHub

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

Questa guida spiega come creare una pipeline CI/CD per testare, sincronizzare ed eseguire il deployment dei DAG nel tuo ambiente Cloud Composer dal tuo repository GitHub.

Se vuoi sincronizzare solo i dati di altri servizi, consulta Trasferire i dati da altri servizi.

Panoramica della pipeline CI/CD

Figura 1. Diagramma dell'architettura che mostra i passaggi del flusso (fai clic per ingrandire)

La pipeline CI/CD per testare, sincronizzare ed eseguire il deployment dei DAG prevede i seguenti passaggi:

1. Apporta una modifica a un DAG ed esegui il push della modifica in un ramo di sviluppo nel tuo repository.

2. Apri una richiesta di pull sul ramo principale del tuo repository.

3. Cloud Build esegue test di unità per verificare la validità del DAG.

4. La richiesta di pull è stata approvata e unita al ramo principale del repository.

5. Cloud Build sincronizza il tuo ambiente Cloud Composer di sviluppo con queste nuove modifiche.

6. Verifica che il DAG si comporti come previsto nell'ambiente di sviluppo.

7. Se il DAG funziona come previsto, caricalo nell'ambiente Cloud Composer di produzione.

Obiettivi

Obiettivo:

• Esegui un controllo pre-invio automatico utilizzando Cloud Build. Questo controllo esegue i test di unità per un DAG.
• Sincronizza i DAG nell'ambiente Cloud Composer di sviluppo con i DAG nel tuo repository GitHub.

Prima di iniziare

• Questa guida presuppone che tu stia lavorando con due ambienti Cloud Composer identici: un ambiente di sviluppo e un ambiente di produzione.

  Ai fini di questa guida, configuri una pipeline CI/CD solo per il tuo ambiente di sviluppo. Assicurati che l'ambiente che utilizzi non sia un ambiente di produzione.

• Questa guida presuppone che tu abbia archiviato i DAG e i relativi test in un repository GitHub.

  La pipeline CI/CD di esempio mostra i contenuti di un repository di esempio. I DAG e i test vengono memorizzati nella directory dags/, con i file dei requisiti, il file dei vincoli e i file di configurazione di Cloud Build archiviati a livello superiore. L'utilità di sincronizzazione DAG e i relativi requisiti si trovano nella directoryutils.

Crea un job di controllo pre-invio e test di unità

Il primo job Cloud Build esegue un controllo pre-invio, che esegue i test di unità per i DAG.

Aggiungere i test delle unità

Se non l'hai ancora fatto, crea test di unità per i tuoi DAG. Salva questi test insieme ai DAG nel tuo repository, ciascuno con il suffisso _test. Ad esempio, il file di test per il DAG in example_dag.py è example_dag_test.py. Si tratta dei test eseguiti come controllo precedente all'invio nel tuo repository.

Crea la configurazione YAML di Cloud Build per il controllo pre-invio

Nel tuo repository, crea un file YAML denominato test-dags.cloudbuild.yaml che configurerà il job Cloud Build per i controlli di preinvio. che prevede tre passaggi:

1. Installa le dipendenze necessarie per i DAG.
2. Installa le dipendenze necessarie per i test delle unità.
3. Esegui i test DAG.

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/"]

Nota: Cloud Build estrae l'immagine Python da Docker Hub e puoi specificare il tag nel campo name di ogni passaggio. Se utilizzi python come entrypoint, assicurati che entrypoint corrisponda alla versione specificata nel tag, altrimenti il valore predefinito di entrypoint è latest.

Crea l'attivatore Cloud Build per il controllo pre-invio

Segui la guida Creazione di repository da GitHub per creare un trigger basato sull'app GitHub con le seguenti configurazioni:

• Nome: test-dags

• Evento: Pull Request

• Origine - Repository: scegli il tuo repository

• Origine - Ramo base: ^main$ (se necessario, sostituisci main con il nome del ramo base del repository)

• Origine - Controllo commenti: non obbligatorio

  Attenzione: se imposti il controllo dei commenti come non obbligatorio, qualsiasi utente può inviare una richiesta pull che attiva la compilazione. Per i repository più grandi o con collaboratori non attendibili, è consigliabile richiedere il controllo dei commenti.

• Configurazione build - File di configurazione Cloud Build: /test-dags.cloudbuild.yaml (il percorso del file di build)

Crea un job di sincronizzazione dei DAG e aggiungi lo script di utilità per i DAG

Successivamente, configura un job Cloud Build che esegue uno script di utilità per i DAG. Lo script di utilità in questo job sincronizza i DAG con l'ambiente Cloud Composer dopo che sono stati uniti al branch principale nel repository.

Nota: Cloud Composer analizza tutti i DAG a un intervallo ripetuto. Questo accade anche se i DAG non sono cambiati dall'ultima analisi. A causa di questo comportamento, questa utility carica tutti i DAG in Cloud Composer, non solo quelli modificati.

Aggiungi lo script di utilità DAG

Aggiungi lo script di utilità DAG al tuo repository. Questo script di utilità copia tutti i file DAG nella directory dags/ del repository in una directory temporanea, ignorando tutti i file Python non DAG. Lo script utilizza quindi la libreria client di Cloud Storage per caricare tutti i file da quella directory temporanea alla directory dags/ nel bucket dell'ambiente Cloud Composer.

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)

Crea la configurazione YAML di Cloud Build per la sincronizzazione dei DAG

Nel tuo repository, crea un file YAML denominato add-dags-to-composer.cloudbuild.yaml che configuri il tuo job Cloud Build per la sincronizzazione dei DAG. che prevede due passaggi:

1. Installa le dipendenze necessarie allo script di utilità DAG.

2. Esegui lo script di utilità per sincronizzare i DAG nel tuo repository con il tuo ambiente Cloud Composer.

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}"]

Nota: Cloud Build estrae l'immagine Python da Docker Hub e puoi specificare il tag nel campo name di ogni passaggio. Se utilizzi python come entrypoint, assicurati che entrypoint corrisponda alla versione specificata nel tag, altrimenti il valore predefinito di entrypoint è latest.

Crea l'trigger di Cloud Build

Segui la guida Creazione di repository da GitHub per creare un trigger basato sull'app GitHub con le seguenti configurazioni:

• Nome: add-dags-to-composer

• Evento: push al ramo

• Origine - Repository: scegli il tuo repository

• Origine - Ramo base: ^main$ (se necessario, sostituisci main con il nome del ramo base del repository)

• Origine - Filtro dei file inclusi (glob): dags/**

• Configurazione build - File di configurazione Cloud Build: /add-dags-to-composer.cloudbuild.yaml (il percorso del file di build)

Nella configurazione avanzata, aggiungi due variabili di sostituzione:

• _DAGS_DIRECTORY: la directory in cui si trovano i DAG nel repository. Se utilizzi il repository di esempio di questa guida, è dags/.

• _DAGS_BUCKET: il bucket Cloud Storage che contiene la directory dags/ nell'ambiente Cloud Composer di sviluppo. Ometti il prefisso gs://. Ad esempio: us-central1-example-env-1234ab56-bucket.

Attenzione: se non rimuovi il suffisso dags/ dal nome del bucket Cloud Storage nella variabile di sostituzione _DAGS_BUCKET, il job di sincronizzazione del DAG non va a buon fine con un errore NotFound. Questo accade perché in Cloud Storage,dags/ è una cartella, che è considerata parte del nome dell'oggetto, non del nome del bucket.

Testa la pipeline CI/CD

In questa sezione, segui un flusso di sviluppo DAG che utilizza gli trigger Cloud Build appena creati.

Esegui un job di pre-invio

Crea una richiesta di pull nel ramo principale per testare la compilazione. Individua il controllo preinvio nella pagina. Fai clic su Dettagli e scegli Visualizza altri dettagli su Google Cloud Build per visualizzare i log di build nella console Google Cloud.

Importante: Cloud Build esegue test di unità con i pacchetti specificati in requirements.txt e requirements-test.txt, che includono una versione pubblica di Airflow. Il tuo ambiente Cloud Composer potrebbe avere un insieme diverso di pacchetti PyPI e pacchetti preinstallati. Ti consigliamo di eseguire un ambiente Airflow locale durante lo sviluppo dei DAG.

Figura 2. Screenshot dello stato del controllo di preinvio di Cloud Build su GitHub (fai clic per ingrandire)

Se il controllo precedente all'invio non è andato a buon fine, consulta Risolvere i problemi di compilazione.

Verifica che il DAG funzioni nell'ambiente Cloud Composer di sviluppo

Una volta approvata la richiesta di pull, uniscila al ramo principale. Utilizza la console Google Cloud per visualizzare i risultati della build. Se hai molti trigger Cloud Build, puoi filtrare le build in base al nome dell'triggeradd-dags-to-composer.

Una volta completato il job di sincronizzazione Cloud Build, il DAG sincronizzato viene visualizzato nel tuo ambiente Cloud Composer di sviluppo. Qui puoi verificare che il DAG funzioni come previsto.

Aggiungi il DAG all'ambiente di produzione

Dopo che il DAG funziona come previsto, aggiungilo manualmente all'ambiente di produzione. A tale scopo, carica il file DAG nella directory dags/ del bucket dell'ambiente Cloud Composer di produzione.

Se il job di sincronizzazione del DAG non è riuscito o se il DAG non si comporta come previsto nell'ambiente Cloud Composer di sviluppo, consulta Risolvere gli errori di compilazione.

Risolvere gli errori di compilazione

Questa sezione spiega come risolvere gli scenari di errore di compilazione più comuni.

Che cosa succede se il controllo precedente l'invio non è andato a buon fine?

Dalla richiesta di pull, fai clic su Dettagli e scegli Visualizza altri dettagli su Google Cloud Build per visualizzare i log di build nella console Google Cloud. Utilizza questi log per risolvere il problema relativo al DAG. Una volta risolti i problemi, esegui il commit della correzione e esegui il push nel tuo branch. Il controllo di preinvio viene eseguito di nuovo e puoi continuare a eseguire l'iterazione utilizzando i log come strumento di debug.

Cosa succede se il mio job di sincronizzazione DAG non va a buon fine?

Utilizza la console Google Cloud per visualizzare i risultati della build. Se hai molti trigger Cloud Build, puoi filtrare le build in base al nome dell'triggeradd-dags-to-composer. Esamina i log del job di compilazione e risolvi gli errori. Se hai bisogno di ulteriore assistenza per risolvere gli errori, utilizza i canali di assistenza.

Cosa succede se il mio DAG non funziona correttamente nel mio ambiente Cloud Composer?

Se il DAG non funziona come previsto nell'ambiente Cloud Composer di sviluppo, non promuoverlo manualmente nell'ambiente Cloud Composer di produzione. Esegui invece una delle seguenti operazioni:

• Ripristina la richiesta di pull con le modifiche che hanno danneggiato il DAG per ripristinarlo allo stato immediatamente precedente alle modifiche (in questo modo vengono ripristinati anche tutti gli altri file della richiesta di pull).
• Crea una nuova richiesta pull per ripristinare manualmente le modifiche al DAG non funzionante.
• Crea una nuova richiesta pull per correggere gli errori nel DAG.

Se segui uno di questi passaggi, viene attivato un nuovo controllo di preinvio e, al termine dell'unione, il job di sincronizzazione DAG.

Passaggi successivi

• Eseguire ambienti Airflow locali
• Scrivere DAG
• Pianificare e attivare i DAG
• Test dei DAG