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
Datei beschrieben.
Inhalt
- Voraussetzungen
- Funktionsweise
- Wann sollten die Plugins verwendet werden
- Übersicht über benutzerdefinierte Plugins
- Beispiele für benutzerdefinierte Plugins
- Eine Datei 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 ausführen können.
-
Berechtigungen — Ihr AWS Konto muss von Ihrem Administrator Zugriff auf die mazonMWAAFullConsoleAccessA-Zugriffskontrollrichtlinie für Ihre Umgebung erhalten haben. Darüber hinaus muss Ihrer MWAA Amazon-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-BucketDAGs, in dem Ihre benutzerdefinierten Plugins und Python-Abhängigkeiten gespeichert werden
plugins.zip
,requirements.txt
muss mit geblocktem öffentlichem 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 MWAA Amazon-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 MWAA Amazon-Konsole angeben. Sie müssen diesen Schritt nur einmal ausführen.
Wann sollten die Plugins verwendet werden
Plugins sind nur für die Erweiterung der Apache Airflow-Benutzeroberfläche erforderlich, wie in der Apache Airflow-Dokumentation/dags
Ordner neben Ihrem DAG
Code platziert werden.
Wenn Sie Ihre eigenen Integrationen mit externen Systemen erstellen müssen, platzieren Sie sie im dags
Ordner/oder einem Unterordner darin, aber nicht im plugins.zip
Ordner. In Apache Airflow 2.x werden Plugins hauptsächlich zur Erweiterung der Benutzeroberfläche verwendet.
Ebenso sollten andere Abhängigkeiten nicht hinzugefügt werden. plugins.zip
Stattdessen können sie an einem Ort unter dem Amazon S3 /dags
S3-Ordner gespeichert werden, wo sie vor dem Start von Apache Airflow mit jedem MWAA Amazon-Container synchronisiert werden.
Anmerkung
Jede Datei im /dags
Ordner oder in der Dateiplugins.zip
, die nicht explizit ein Apache DAG Airflow-Objekt definiert, muss in einer .airflowignore
Datei aufgeführt werden.
Ü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 begrenzt zwar MWAA nicht explizit die Größe einerplugins.zip
Datei, aber wenn Abhängigkeiten nicht innerhalb von zehn Minuten installiert werden können, gibt der Fargate-Dienst ein Timeout ab 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, MWAA begrenzt Amazon 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 MWAA kann Amazon 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 mit einer verschachtelten Verzeichnisstruktur in plugins.zip
Eine Datei 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 MWAA CLI Amazon-Hilfsprogramm
-
Das Befehlszeilenprogramm interface (CLI) repliziert eine Amazon Managed Workflows for Apache Airflow-Umgebung lokal.
-
Das CLI erstellt lokal ein Docker-Container-Image, das einem MWAA Amazon-Produktions-Image ähnelt. Auf diese Weise können Sie eine lokale Apache Airflow-Umgebung ausführen, um benutzerdefinierte Plugins und Abhängigkeiten zu entwickeln und zu testenDAGs, bevor Sie sie auf Amazon MWAA bereitstellen.
-
Informationen zum CLI Ausführen von 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. Beispielsweise:
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.
Mit dem AWS CLI
The AWS Command Line Interface (AWS CLI) ist ein Open-Source-Tool, mit dem Sie mithilfe von Befehlen in Ihrer Befehlszeilen-Shell mit AWS Diensten 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. Beispielsweise: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 MWAA Amazon-Konsole. -
Wählen Sie eine Umgebung aus.
-
Wählen Sie im Bereich DAGCode 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.
Angabe des Pfads zu plugins.zip
auf der MWAA Amazon-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 MWAA Amazon-Konsole angeben. Sie müssen diesen Schritt nur einmal ausführen.
-
Öffnen Sie die Seite Umgebungen
auf der MWAA Amazon-Konsole. -
Wählen Sie eine Umgebung aus.
-
Wählen Sie Edit (Bearbeiten) aus.
-
Wählen Sie im Bereich DAGCode 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 MWAA Amazon-Konsole
Sie müssen jedes Mal, wenn Sie eine neue Version Ihrer plugins.zip
Datei plugins.zip
in Ihren Amazon S3-Bucket hochladen, die Version Ihrer Datei auf der MWAA Amazon-Konsole angeben.
-
Öffnen Sie die Seite Umgebungen
auf der MWAA Amazon-Konsole. -
Wählen Sie eine Umgebung aus.
-
Wählen Sie Edit (Bearbeiten) aus.
-
Wählen Sie im Bereich DAGCode 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 Patchen PythonVirtualenvOperator .
-
Erfahren Sie in, wie Sie ein benutzerdefiniertes Plugin erstellenBenutzerdefiniertes Plugin mit Oracle.
-
Erfahren Sie in, wie Sie ein benutzerdefiniertes Plugin erstellenDAGDie Zeitzone von a bei Amazon ändern MWAA.
Als nächstes
-
Testen Sie Ihre DAGs benutzerdefinierten Plugins und Python-Abhängigkeiten lokal mit dem aws-mwaa-local-runner
on GitHub.