Auf die Apache Airflow-Weboberfläche zugreifen

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Apache Airflow enthält eine Benutzeroberfläche (UI), mit der Sie Workflows (DAGs) verwalten, die Airflow-Umgebung verwalten und administrative Aktionen ausführen können. Beispielsweise haben Sie die Möglichkeit, mit der Weboberfläche den Fortschritt eines DAG zu prüfen, eine neue Datenverbindung einzurichten oder Logs aus der Ausführung vorheriger DAGs zu prüfen.

Airflow-Webserver

Jede Cloud Composer-Umgebung verfügt über einen Webserver, auf dem die Airflow-Weboberfläche ausgeführt wird. Der Webserver ist Teil der Cloud Composer-Umgebungsarchitektur.

Der Webserver parst die DAG-Definitionsdateien im Ordner dags/. Er muss die Möglichkeit haben, auf die Daten und Ressourcen eines DAG zuzugreifen, um den DAG laden und HTTP-Anfragen senden zu können.

Der Webserver aktualisiert die DAGs alle 60 Sekunden. Dies ist der Standardwert für worker_refresh_interval in Cloud Composer. Sollte der Webserver nicht alle DAGs innerhalb des Aktualisierungsintervalls parsen können, tritt eventuell ein Webserverfehler auf.

Wenn eine große Anzahl an DAG-Dateien oder eine komplexe Arbeitslast zum Laden der DAG-Dateien vorhanden ist, kann das Laden von DAGs mehr als 60 Sekunden dauern. Damit der Webserver unabhängig von der DAG-Ladezeit verfügbar bleibt, können Sie ein asynchrones Laden von DAGs konfigurieren, um DAGs im Hintergrund in einem vorkonfigurierten Intervall zu parsen und zu laden (in composer-1.7.1-airflow-1.10.2 und höheren Versionen verfügbar). Diese Konfiguration kann auch die DAG-Aktualisierungszeit reduzieren.

Mit Ausnahme einer Überschreitung des Worker-Aktualisierungsintervalls kann der Webserver die meisten DAG-Ladefehler problemlos bewältigen. Bei DAGs, die einen Absturz oder ein Schließen des Webservers verursachen, werden eventuell Fehler im Browser zurückgegeben. Weitere Informationen finden Sie unter Fehlerbehebung bei DAGs.

Wenn das Parsen von DAGs dauerhaft Webserverprobleme verursacht, empfehlen wir, DAGs asynchron zu laden.

Hinweise

• Sie benötigen eine Rolle, die Cloud Composer-Umgebungen aufrufen kann. Weitere Informationen finden Sie unter Zugriffssteuerung.

• Während der Erstellung der Umgebung konfiguriert Cloud Composer die URL für den Webserver, auf dem die Airflow-Weboberfläche ausgeführt wird. Die URL kann nicht angepasst werden.

• Die Airflow-UI-Zugriffssteuerung (rollenbasierte Zugriffssteuerung von Airflow) für die Airflow-Weboberfläche wird für Cloud Composer-Umgebungen mit Composer-Version 1.13.4 oder höher, Airflow-Version 1.10.10 oder höher und Python 3 unterstützt.

Auf die Airflow-Weboberfläche zugreifen

Der Dienst für den Airflow-Webserver wird in der Domain appspot.com bereitgestellt und bietet Zugriff auf die Airflow-Weboberfläche. Cloud Composer 1 bietet Zugriff auf die Benutzeroberfläche basierend auf Nutzeridentitäten und IAM-Richtlinienbindungen, die für Nutzer definiert sind. Cloud Composer 1 verwendet zu diesem Zweck Identity-Aware Proxy.

Nach dem Erstellen einer neuen Cloud Composer-Umgebung dauert es bis zu 25 Minuten, bis die Weboberfläche das Hosting vollendet hat und der Zugriff darauf möglich ist.

Über die Google Cloud Console auf die Weboberfläche zugreifen

So greifen Sie über die Google Cloud Console auf die Airflow-Weboberfläche zu:

1. Rufen Sie in der Google Cloud Console die Seite Umgebungen auf.

   Zur Seite Umgebungen“

2. Klicken Sie in der Spalte Airflow-Webserver auf den Link Airflow für Ihre Umgebung.

3. Melden Sie sich mit einem Google-Konto an, das über die entsprechenden Berechtigungen verfügt.

Zugriff auf den Airflow-Webserver beschränken

Mit Composer-Umgebungen können Sie den Zugriff auf den Airflow-Webserver beschränken:

• Sie können den gesamten Zugriff blockieren oder den Zugriff von bestimmten externen IPv4- oder IPv6-IP-Bereichen zulassen.
• Die zulässigen IP-Bereiche können nicht mit privaten IP-Adressen konfiguriert werden.

URL der Weboberfläche mit dem gcloud-Befehlszeilentool abrufen

Sie können über einen beliebigen Webbrowser auf die Airflow-Weboberfläche zugreifen. Zum Abrufen der URL für die Weboberfläche geben Sie diesen gcloud-Befehl ein:

gcloud composer environments describe ENVIRONMENT_NAME \
  --location LOCATION

Ersetzen Sie Folgendes:

• ENVIRONMENT_NAME: der Name Ihrer Umgebung
• LOCATION: Region, in der sich die Umgebung befindet.

Der gcloud-Befehl zeigt die Attribute einer Cloud Composer-Umgebung an, einschließlich der URL für die Weboberfläche. Die URL ist als airflowUri aufgeführt.

config:
  airflowUri: https://example-tp.appspot.com

Asynchrones Laden von DAGs konfigurieren

Wenn das asynchrone Laden von DAGs aktiviert ist, erstellt der Airflow-Webserver einen neuen Prozess. Dieser Prozess lädt DAGs im Hintergrund, sendet neu geladene DAGs in Intervallen, die mit der Option dagbag_sync_interval definiert sind, und pausiert dann.

Der Prozess wird regelmäßig angestoßen, um DAGs neu zu laden. Das Intervall wird durch die Option collect_dags_interval definiert.

So aktivieren Sie das asynchrone Laden von DAGs:

1. DAG-Serialisierung deaktivieren. Das asynchrone Laden von DAGs kann nicht mit der DAG-Serialisierung verwendet werden. Bei Verwendung der Airflow-Konfigurationsoptionen async_dagbag_loader und store_serialized_dags werden HTTP-503-Fehler erzeugt und die Umgebung wird beeinträchtigt.

2. Überschreiben Sie die folgenden Airflow-Konfigurationsoptionen:

   Bereich	Schlüssel	Wert	Notes
   webserver	async_dagbag_loader	True	Der Standardwert ist False.
   webserver	collect_dags_interval	30	Der Standardwert ist 30. Verwenden Sie einen kleineren Wert für schnellere Aktualisierungen.
   webserver	dagbag_sync_interval	10	Der Standardwert ist 10.
   webserver	worker_refresh_interval	3600	Der Standardwert ist 60. Beim asynchronen Laden von DAGs können Sie ein längeres Aktualisierungsintervall verwenden.

Webserver neu starten

Vorschau — Web server restarting

Diese Funktion unterliegt den „Nutzungsbedingungen für Pre-GA-Angebote“ im Abschnitt „Allgemeine Nutzungsbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Funktionen sind „wie besehen“ verfügbar und werden möglicherweise nur eingeschränkt unterstützt. Weitere Informationen finden Sie in den Beschreibungen der Startphase.

Bei dem Debugging oder der Fehlerbehebung in Cloud Composer-Umgebungen können einige Probleme möglicherweise durch einen Neustart des Airflow-Webservers behoben werden. Sie können den Webserver mit der restartWebWeb API oder dem gcloud-Befehl restart-web-server neu starten:

gcloud beta composer environments restart-web-server ENVIRONMENT_NAME \
  --location=LOCATION

Netzwerkzugriff auf Webserver konfigurieren

Die Zugriffsparameter des Airflow-Webservers hängen nicht vom Typ der Umgebung ab. Stattdessen konfigurieren Sie den Webserverzugriff separat. Beispiel: In einer privaten IP-Umgebung kann die Airflow-UI weiterhin über das Internet zugänglich sein.

Die zulässigen IP-Bereiche können nicht mit privaten IP-Adressen konfiguriert werden.

Hinweis: Der Airflow-Webserver Ihrer Umgebung ist immer durch IAM geschützt, unabhängig von den IP-Bereichen, die darauf zugreifen dürfen.

Console

1. Rufen Sie in der Google Cloud Console die Seite Umgebungen auf.

   Zur Seite Umgebungen“

2. Klicken Sie in der Liste der Umgebungen auf den Namen Ihrer Umgebung. Die Seite Umgebungsdetails wird geöffnet.

3. Rufen Sie den Tab Umgebungskonfiguration auf.

4. Klicken Sie im Abschnitt Netzwerkkonfiguration unter Webserver-Zugriffssteuerung auf Bearbeiten.

5. Gehen Sie im Dialogfeld Webserver-Netzwerkzugriffssteuerung so vor:

   • Wenn Sie Zugriff auf den Airflow-Webserver von allen IP-Adressen gewähren möchten, wählen Sie Zugriff von allen IP-Adressen zulassen aus.

   • Wenn Sie den Zugriff nur auf bestimmte IP-Bereiche beschränken möchten, wählen Sie Zugriff nur von bestimmten IP-Adressen zulassen aus. Geben Sie im Feld IP-Bereich einen IP-Bereich in der CIDR-Notation an. Geben Sie im Feld Beschreibung eine optionale Beschreibung für diesen Bereich ein. Wenn Sie mehr als einen Bereich angeben möchten, klicken Sie auf IP-Bereich hinzufügen.

   • Um den Zugriff für alle IP-Adressen zu verbieten, wählen Sie Zugriff nur von bestimmten IP-Adressen zulassen aus und klicken Sie neben dem leeren Bereichseintrag auf Element löschen.

gcloud

Wenn Sie eine Umgebung aktualisieren, werden die Zugriffsparameter des Webservers mit den folgenden Argumenten gesteuert:

• --web-server-allow-all bietet von allen IP-Adressen Zugriff auf Airflow. Dies ist die Standardoption.

• --web-server-allow-ip beschränkt den Zugriff auf bestimmte Quell-IP-Bereiche. Wenn Sie mehrere IP-Bereiche angeben möchten, verwenden Sie dieses Argument mehrmals.

• --web-server-deny-all unterbindet den Zugriff für alle IP-Adressen.

Hinweis: Der Airflow-Webserver Ihrer Umgebung ist immer durch IAM geschützt, unabhängig von den IP-Bereichen, die darauf zugreifen dürfen.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --web-server-allow-ip ip_range=WS_IP_RANGE,description=WS_RANGE_DESCRIPTION

Ersetzen Sie Folgendes:

• ENVIRONMENT_NAME: der Name Ihrer Umgebung
• LOCATION: Region, in der sich die Umgebung befindet.
• WS_IP_RANGE: der IP-Bereich in CIDR-Notation, der auf die Airflow-UI zugreifen kann.
• WS_RANGE_DESCRIPTION: die Beschreibung des IP-Bereichs

Beispiel:

gcloud composer environments update example-environment \
    --location us-central1 \
    --web-server-allow-ip ip_range=192.0.2.0/24,description="office net 1" \
    --web-server-allow-ip ip_range=192.0.4.0/24,description="office net 3"

API

1. Erstellen Sie eine API-Anfrage [environments.patch][api-patch].

2. In dieser Anfrage:

   1. Geben Sie im Parameter updateMask die Maske config.webServerNetworkAccessControl an.

   2. Geben Sie im Anfragetext an, wie Airflow-Aufgabenlogs gespeichert werden sollen:

      • Wenn Sie Zugriff auf Airflow von allen IP-Adressen gewähren möchten, geben Sie ein leeres config-Element an. Das Element webServerNetworkAccessControl darf nicht vorhanden sein.

      • Wenn Sie den Zugriff auf bestimmte IP-Bereiche beschränken möchten, geben Sie in allowedIpRanges einen oder mehrere Bereiche an.

      • Geben Sie ein leeres webServerNetworkAccessControl-Element an, um den Zugriff für alle IP-Adressen zu verbieten. Das Element webServerNetworkAccessControl muss vorhanden sein, darf aber kein Element vom Typ allowedIpRanges enthalten.

Hinweis: Der Airflow-Webserver Ihrer Umgebung ist immer durch IAM geschützt, unabhängig von den IP-Bereichen, die darauf zugreifen dürfen.

{
  "config": {
    "webServerNetworkAccessControl": {
      "allowedIpRanges": [
        {
          "value": "WS_IP_RANGE",
          "description": "WS_RANGE_DESCRIPTION"
        }
      ]
    }
  }
}

Ersetzen Sie Folgendes:

• WS_IP_RANGE: der IP-Bereich in CIDR-Notation, der auf die Airflow-UI zugreifen kann.
• WS_RANGE_DESCRIPTION: die Beschreibung des IP-Bereichs

Beispiel:

// PATCH https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.webServerNetworkAccessControl

{
  "config": {
    "webServerNetworkAccessControl": {
      "allowedIpRanges": [
        {
          "value": "192.0.2.0/24",
          "description": "office net 1"
        },
        {
          "value": "192.0.4.0/24",
          "description": "office net 3"
        }
      ]
    }
  }
}

Terraform

Geben Sie im Block allowed_ip_range in der web_server_network_access_control IP-Bereiche an, die auf den Webserver zugreifen können.

Hinweis: Der Airflow-Webserver Ihrer Umgebung ist immer durch IAM geschützt, unabhängig von den IP-Bereichen, die darauf zugreifen dürfen.

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {

    web_server_network_access_control {

      allowed_ip_range {
        value = "WS_IP_RANGE"
        description = "WS_RANGE_DESCRIPTION"
      }

    }

  }
}

Ersetzen Sie:

• WS_IP_RANGE durch den IP-Bereich (in CIDR-Notation), der auf die Airflow-UI zugreifen darf.
• WS_RANGE_DESCRIPTION durch die Beschreibung des IP-Bereichs.

Beispiel:

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "example-environment"
  region = "us-central1"

  config {

    web_server_network_access_control {
      allowed_ip_range {
        value = "192.0.2.0/24"
        description = "office net 1"
      },
      allowed_ip_range {
        value = "192.0.4.0/24"
        description = "office net 3"
      }

    }
}

Nächste Schritte

• Airflow-UI-Zugriffssteuerung
• Probleme mit dem Airflow-Webserver beheben