Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Installation benutzerdefinierter Plugins
Amazon Managed Workflows for Apache Airflow unterstützt den integrierten Plugin-Manager von Apache Airflow, sodass Sie benutzerdefinierte Apache Airflow-Operatoren, Hooks, Sensoren oder Schnittstellen verwenden können. Auf dieser Seite werden die Schritte zur Installation benutzerdefinierter Apache Airflow-Pluginsplugins.zip
Inhalt
- Voraussetzungen
- Funktionsweise
- Was hat sich in Version 2 geändert
- Übersicht über benutzerdefinierte Plugins
- Beispiele für benutzerdefinierte Plugins
- Eine Datei vom Typ plugins.zip erstellen
- Auf Amazon plugins.zip S3 hochladen
- Installation benutzerdefinierter Plugins in Ihrer Umgebung
- Beispielhafte Anwendungsfälle für plugins.zip
- Als nächstes
Voraussetzungen
Sie benötigen Folgendes, bevor Sie die Schritte auf dieser Seite abschließen können.
-
Berechtigungen — Ihr AWS Konto muss von Ihrem Administrator Zugriff auf die FullConsoleAccessAmazonMWAA-Zugriffskontrollrichtlinie für Ihre Umgebung erhalten haben. Darüber hinaus muss Ihrer Amazon MWAA-Umgebung von Ihrer Ausführungsrolle der Zugriff auf die von Ihrer Umgebung verwendeten AWS Ressourcen gestattet werden.
-
Zugriff — Wenn Sie Zugriff auf öffentliche Repositorys benötigen, um Abhängigkeiten direkt auf dem Webserver zu installieren, muss Ihre Umgebung für den Zugriff auf öffentliche Netzwerk-Webserver konfiguriert sein. Weitere Informationen finden Sie unter Apache Airflow-Zugriffsmodi.
-
Amazon S3 S3-Konfiguration — Der Amazon S3 S3-Bucket, der zum Speichern Ihrer DAGs, benutzerdefinierten Plugins und Python-Abhängigkeiten verwendet wird
plugins.zip
,requirements.txt
muss mit geblocktem öffentlichen Zugriff und aktivierter Versionierung konfiguriert sein.
Funktionsweise
Um benutzerdefinierte Plugins in Ihrer Umgebung auszuführen, müssen Sie drei Dinge tun:
-
Erstellen Sie lokal eine
plugins.zip
Datei. -
Laden Sie die lokale
plugins.zip
Datei in Ihren Amazon S3 S3-Bucket hoch. -
Geben Sie die Version dieser Datei im Feld Plugins-Datei auf der Amazon MWAA-Konsole an.
Anmerkung
Wenn Sie zum ersten Mal einen plugins.zip
in Ihren Amazon S3 S3-Bucket hochladen, müssen Sie auch den Pfad zu der Datei auf der Amazon MWAA-Konsole angeben. Sie müssen diesen Schritt nur einmal ausführen.
Was hat sich in Version 2 geändert
-
Neu: Operatoren, Hooks und Executors. Die Import-Anweisungen in Ihren DAGs und die benutzerdefinierten Plugins, die Sie in einem MWAA
plugins.zip
auf Amazon angeben, haben sich zwischen Apache Airflow v1 und Apache Airflow v2 geändert. Beispielsweise wurdefrom airflow.contrib.hooks.aws_hook import AwsHook
in Apache Airflow v1 zu Apache Airflow v2 geändert.from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook
Weitere Informationen finden Sie in der Python-API-Referenzim Apache Airflow-Referenzhandbuch. -
Neu: Importe in Plugins. Das Importieren von Operatoren, Sensoren und Hooks, die mithilfe von Plugins hinzugefügt wurden,
airflow.{operators,sensors,hooks}.<plugin_name>
wird nicht mehr unterstützt. Diese Erweiterungen sollten als reguläre Python-Module importiert werden. In Version 2 und höher besteht der empfohlene Ansatz darin, sie im DAG-Verzeichnis zu platzieren und eine .airflowignore-Datei zu erstellen und zu verwenden, um sie von der Analyse als DAGs auszuschließen. Weitere Informationen finden Sie unter Modulverwaltungund Erstellen eines benutzerdefinierten Operators im Apache Airflow-Referenzhandbuch.
Übersicht über benutzerdefinierte Plugins
Der integrierte Plugin-Manager von Apache Airflow kann externe Funktionen in seinen Kern integrieren, indem er Dateien einfach in einem $AIRFLOW_HOME/plugins
Ordner ablegt. Es ermöglicht Ihnen, benutzerdefinierte Apache Airflow-Operatoren, Hooks, Sensoren oder Schnittstellen zu verwenden. Der folgende Abschnitt enthält ein Beispiel für flache und verschachtelte Verzeichnisstrukturen in einer lokalen Entwicklungsumgebung und die daraus resultierenden Importanweisungen, die die Verzeichnisstruktur innerhalb einer plugins.zip bestimmen.
Verzeichnis- und Größenbeschränkungen für benutzerdefinierte Plugins
Der Apache Airflow Scheduler und die Workers suchen beim Start auf dem AWS -verwalteten Fargate-Container für Ihre Umgebung unter nach benutzerdefinierten Plugins. /usr/local/airflow/plugins/
*
-
Verzeichnisstruktur. Die Verzeichnisstruktur (at
/
) basiert auf dem Inhalt Ihrer*
plugins.zip
Datei. Wenn Ihr Verzeichnis beispielsweise alsoperators
Verzeichnis der obersten Ebeneplugins.zip
enthält, wird das Verzeichnis in Ihre Umgebung extrahiert./usr/local/airflow/plugins/
operators
-
Größenbeschränkung. Wir empfehlen eine
plugins.zip
Datei mit weniger als 1 GB. Je größer eineplugins.zip
Datei, desto länger ist die Startzeit in einer Umgebung. Amazon MWAA begrenzt die Größe einerplugins.zip
Datei zwar nicht explizit, aber wenn Abhängigkeiten nicht innerhalb von zehn Minuten installiert werden können, führt der Fargate-Service zu einem Timeout und versucht, die Umgebung auf einen stabilen Zustand zurückzusetzen.
Anmerkung
Für Umgebungen, die Apache Airflow v1.10.12 oder Apache Airflow v2.0.2 verwenden, begrenzt Amazon MWAA den ausgehenden Datenverkehr auf dem Apache Airflow-Webserver und erlaubt Ihnen nicht, Plugins oder Python-Abhängigkeiten direkt auf dem Webserver zu installieren. Ab Apache Airflow v2.2.2 kann Amazon MWAA Plugins und Abhängigkeiten direkt auf dem Webserver installieren.
Beispiele für benutzerdefinierte Plugins
Im folgenden Abschnitt wird anhand von Beispielcode aus dem Apache Airflow-Referenzhandbuch gezeigt, wie Sie Ihre lokale Entwicklungsumgebung strukturieren können.
Beispiel für die Verwendung einer flachen Verzeichnisstruktur in plugins.zip
Beispiel für die Verwendung einer verschachtelten Verzeichnisstruktur in plugins.zip
Eine Datei vom Typ plugins.zip erstellen
In den folgenden Schritten werden die Schritte beschrieben, die wir empfehlen, um eine Datei plugins.zip lokal zu erstellen.
Schritt eins: Testen Sie benutzerdefinierte Plugins mit dem Amazon MWAA CLI-Hilfsprogramm
-
Das Befehlszeilenschnittstellenprogramm (CLI) repliziert eine Amazon Managed Workflows for Apache Airflow-Umgebung lokal.
-
Die CLI erstellt lokal ein Docker-Container-Image, das einem Amazon MWAA-Produktionsimage ähnelt. Auf diese Weise können Sie eine lokale Apache Airflow-Umgebung ausführen, um DAGs, benutzerdefinierte Plugins und Abhängigkeiten zu entwickeln und zu testen, bevor Sie sie auf Amazon MWAA bereitstellen.
-
Informationen zum Ausführen der CLI finden Sie aws-mwaa-local-runner
unter GitHub.
Schritt zwei: Erstellen Sie die Datei plugins.zip
Sie können ein integriertes ZIP-Archivierungsprogramm oder ein anderes ZIP-Hilfsprogramm (z. B. 7zip
Anmerkung
Das integrierte ZIP-Hilfsprogramm für Windows OS fügt möglicherweise Unterordner hinzu, wenn Sie eine ZIP-Datei erstellen. Wir empfehlen, den Inhalt der Datei plugins.zip vor dem Hochladen in Ihren Amazon S3 S3-Bucket zu überprüfen, um sicherzustellen, dass keine zusätzlichen Verzeichnisse hinzugefügt wurden.
-
Wechseln Sie zu den Verzeichnissen in Ihr lokales Airflow-Plugin-Verzeichnis. Beispiel:
myproject$
cd plugins
-
Führen Sie den folgenden Befehl aus, um sicherzustellen, dass der Inhalt über Ausführungsberechtigungen verfügt (nur macOS und Linux).
plugins$
chmod -R 755 .
-
Komprimieren Sie den Inhalt Ihres
plugins
Ordners.plugins$
zip -r plugins.zip .
Auf Amazon plugins.zip
S3 hochladen
Sie können die Amazon S3 S3-Konsole oder die AWS Command Line Interface (AWS CLI) verwenden, um eine plugins.zip
Datei in Ihren Amazon S3 S3-Bucket hochzuladen.
Verwenden der AWS CLI
Die AWS Command Line Interface (AWS CLI) ist ein Open-Source-Tool, mit dem Sie über Befehle in Ihrer Befehlszeilen-Shell mit den AWS-Services interagieren können. Um die Schritte auf dieser Seite abzuschließen, benötigen Sie Folgendes:
Zum Hochladen mit dem AWS CLI
-
Navigieren Sie in der Befehlszeile zu dem Verzeichnis, in dem Ihre
plugins.zip
Datei gespeichert ist. Beispiel:cd plugins
-
Verwenden Sie den folgenden Befehl, um alle Ihre Amazon S3 S3-Buckets aufzulisten.
aws s3 ls
-
Verwenden Sie den folgenden Befehl, um die Dateien und Ordner im Amazon S3 S3-Bucket für Ihre Umgebung aufzulisten.
aws s3 ls s3://
YOUR_S3_BUCKET_NAME
-
Verwenden Sie den folgenden Befehl, um die
plugins.zip
Datei in den Amazon S3 S3-Bucket für Ihre Umgebung hochzuladen.aws s3 cp plugins.zip s3://
YOUR_S3_BUCKET_NAME
/plugins.zip
Verwenden der Amazon S3-Konsole
Die Amazon S3 S3-Konsole ist eine webbasierte Benutzeroberfläche, mit der Sie die Ressourcen in Ihrem Amazon S3 S3-Bucket erstellen und verwalten können.
Um mit der Amazon S3 S3-Konsole hochzuladen
-
Öffnen Sie die Seite Umgebungen
auf der Amazon MWAA-Konsole. -
Wählen Sie eine Umgebung aus.
-
Wählen Sie im Bereich DAG-Code im Bereich S3 den Link S3-Bucket aus, um Ihren Speicher-Bucket auf der Amazon S3 S3-Konsole zu öffnen.
-
Klicken Sie auf Hochladen.
-
Wählen Sie Datei hinzufügen.
-
Wählen Sie die lokale Kopie Ihres aus
plugins.zip
und wählen Sie Hochladen.
Installation benutzerdefinierter Plugins in Ihrer Umgebung
In diesem Abschnitt wird beschrieben, wie Sie die benutzerdefinierten Plugins, die Sie in Ihren Amazon S3 S3-Bucket hochgeladen haben, installieren, indem Sie bei jeder Aktualisierung der ZIP-Datei den Pfad zur Datei plugins.zip und die Version der Datei plugins.zip angeben.
Angeben des Pfads zu plugins.zip
auf der Amazon MWAA-Konsole (beim ersten Mal)
Wenn Sie zum ersten Mal einen plugins.zip
in Ihren Amazon S3 S3-Bucket hochladen, müssen Sie auch den Pfad zu der Datei auf der Amazon MWAA-Konsole angeben. Sie müssen diesen Schritt nur einmal ausführen.
-
Öffnen Sie die Seite Umgebungen
auf der Amazon MWAA-Konsole. -
Wählen Sie eine Umgebung aus.
-
Wählen Sie Bearbeiten aus.
-
Wählen Sie im Bereich DAG-Code in Amazon S3 neben dem Feld Plugins-Datei — optional die Option S3 durchsuchen aus.
-
Wählen Sie die
plugins.zip
Datei in Ihrem Amazon S3 S3-Bucket aus. -
Wählen Sie Choose (Auswählen) aus.
-
Wählen Sie Weiter, Umgebung aktualisieren.
Angabe der plugins.zip
Version auf der Amazon MWAA-Konsole
Sie müssen die Version Ihrer plugins.zip
Datei auf der Amazon MWAA-Konsole jedes Mal angeben, wenn Sie eine neue Version Ihrer Datei plugins.zip
in Ihren Amazon S3 S3-Bucket hochladen.
-
Öffnen Sie die Seite Umgebungen
auf der Amazon MWAA-Konsole. -
Wählen Sie eine Umgebung aus.
-
Wählen Sie Bearbeiten aus.
-
Wählen Sie im Bereich DAG-Code in Amazon S3 eine
plugins.zip
Version aus der Dropdownliste aus. -
Wählen Sie Weiter.
Beispielhafte Anwendungsfälle für plugins.zip
-
Erfahren Sie in, wie Sie ein benutzerdefiniertes Plugin erstellenBenutzerdefiniertes Plugin mit Apache Hive und Hadoop.
-
Erfahren Sie in, wie Sie ein benutzerdefiniertes Plugin erstellenBenutzerdefiniertes Plugin zum PatchenPythonVirtualenvOperator .
-
Erfahren Sie in, wie Sie ein benutzerdefiniertes Plugin erstellenBenutzerdefiniertes Plugin mit Oracle.
-
Erfahren Sie in, wie Sie ein benutzerdefiniertes Plugin erstellenÄndern der Zeitzone einer DAG auf Amazon MWAA.
Als nächstes
-
Testen Sie Ihre DAGs, benutzerdefinierten Plugins und Python-Abhängigkeiten lokal mit dem aws-mwaa-local-runner
on GitHub.