Auf Airflow-Befehlszeile zugreifen

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Apache Airflow bietet eine Befehlszeile, mit der Sie Aufgaben wie das Auslösen und Verwalten von DAGs, das Abrufen von Informationen zu DAG-Ausführungen und -Aufgaben, das Hinzufügen und Löschen von Verbindungen und Nutzern ausführen können.

Über CLI-Syntaxversionen

Airflow in Cloud Composer 1 bietet zwei verschiedene Syntaxen für Befehlszeilenbefehle:

Unterstützte Befehle der Airflow-Befehlszeile

Eine vollständige Liste der unterstützten Airflow-Befehlszeilenbefehle finden Sie in der Referenz zu gcloud composer environments run.

Hinweise

  • Sie benötigen ausreichende Berechtigungen, um die gcloud-Befehlszeile zu verwenden mit Cloud Composer erstellen und Airflow-Befehlszeilenbefehle ausführen. Weitere Informationen finden Sie unter Zugriffssteuerung.

  • In Cloud Composer-Versionen vor 2.4.0 benötigen Sie Zugriff auf die Steuerungsebene des Umgebungsclusters um Befehle der Airflow-Befehlszeile auszuführen.

Befehle der Airflow-Befehlszeile ausführen

Zum Ausführen von Befehlen der Airflow-Befehlszeile in Ihren Umgebungen verwenden Sie gcloud:

gcloud composer environments run ENVIRONMENT_NAME \
    --location LOCATION \
    SUBCOMMAND \
    -- SUBCOMMAND_ARGUMENTS

Ersetzen Sie:

  • ENVIRONMENT_NAME durch den Namen der Umgebung.
  • LOCATION durch die Region, in der sich die Umgebung befindet.
  • SUBCOMMAND durch einen der unterstützten Airflow-Befehlszeilenbefehle.
  • SUBCOMMAND_ARGUMENTS durch Argumente für den Airflow-Befehlszeilenbefehl.

Trennzeichen für Unterbefehle

Trennen Sie die Argumente für den angegebenen Airflow-Befehlszeilenbefehl durch --:

Airflow 2

Für die Syntax der Airflow-2-Befehlszeile:

  • Geben Sie zusammengesetzte CLI-Befehle als Unterbefehl an.
  • Geben Sie alle Argumente für zusammengesetzte Befehle als Unterbefehlargumente an. nach einem ---Trennzeichen ein.
gcloud composer environments run example-environment \
    dags list -- --output=json

Airflow 1

Für die Syntax der Airflow-1.10-Befehlszeile:

  • Geben Sie die Befehlszeilenbefehle als Unterbefehl an.
  • Geben Sie alle Argumente nach dem Trennzeichen -- an.
gcloud composer environments run example-environment \
    list_dags -- --report

Standardort

Für die meisten gcloud composer-Befehle ist ein Speicherort erforderlich. Sie können den Speicherort mit dem Flag --location oder durch Festlegen des Standardspeicherorts angeben.

Beispiel

Beispielsweise haben Sie die Möglichkeit, mit dem folgenden Befehl einen DAG namens sample_quickstart mit der ID 5077 in Ihrer Cloud Composer-Umgebung auszulösen:

Airflow 2 

gcloud composer environments run example-environment \
    --location us-central1 dags trigger -- sample_quickstart \
    --run-id=5077

Airflow 1 

gcloud composer environments run example-environment \
    --location us-central1 trigger_dag -- sample_quickstart \
    --run_id=5077

Befehle in einer privaten IP-Umgebung ausführen

So führen Sie Befehle der Airflow-Befehlszeile in einer privaten IP-Umgebung aus: auf einer Maschine ausführen, die auf den GKE-Cluster Endpunkt der Steuerungsebene. Die Optionen variieren dabei abhängig von Ihrer privaten Clusterkonfiguration.

Wenn der Zugriff auf öffentliche Endpunkte im Cluster Ihrer Umgebung deaktiviert ist, kann die Airflow-Befehlszeile nicht mit gcloud composer-Befehlen ausgeführt werden. Führen Sie die folgenden Schritte aus, um Airflow-Befehle in der Befehlszeile ausführen zu können:

  1. VM in Ihrem VPC-Netzwerk erstellen
  2. Rufen Sie die Clusteranmeldedaten ab. Führen Sie dazu diesen Befehl aus: bash gcloud container clusters get-credentials CLUSTER_NAME \ --region REGION \ --project PROJECT \ --internal-ip
  • Führen Sie den Airflow-Befehl mit kubectl aus. Beispiel:
kubectl exec deployment/airflow-scheduler -n COMPOSER_NAMESPACE \
  --container airflow-scheduler -- airflow dags list

Ersetzen Sie COMPOSER_NAMESPACE durch einen Namespace wie composer-2-0-28-airflow-2-3-394zxc12411. Sie können Ihren Cloud Composer suchen in der Liste der Arbeitslasten oder mithilfe des Befehls kubectl get namespaces.

Wenn im Cluster Ihrer Umgebung der Zugriff auf öffentliche Endpunkte aktiviert ist, haben Sie folgende Möglichkeiten: Airflow-Kommandozeilenbefehle auf einer Maschine mit einer externen IP-Adresse, zu autorisierten Netzwerken hinzugefügt. Um den Zugriff von Ihrem Computer aus zu ermöglichen, fügen Sie den der externen Adresse Ihres Computers an die Liste der autorisierten Netzwerke.

Fehlerbehebung

Keine Verbindung zur Steuerungsebene des Clusters

Bei Ausführung von gcloud composer environments run oder kubectl-Befehle verwenden, wird möglicherweise der folgende Fehler angezeigt:

Get "https://<IP Address>/api?timeout=32s": dial tcp <IP Address>:443: i/o timeout"

Symptom: Diese Fehlermeldung gibt an, dass von einem Computer, auf dem Sie diese Befehle ausführen, keine Netzwerkverbindung besteht.

Lösung: Folgen Sie der Anleitung im Abschnitt Befehle in einer privaten IP-Umgebung ausführen oder verwenden Sie die Anleitung im Abschnitt kubectl-Befehl läuft ab.