Benutzerdefinierte Plug-ins installieren

Cloud Composer 1 Cloud Composer 2

Mit dem Plug-in-Manager von Apache Airflow können Sie benutzerdefinierte interne Operatoren, Hooks, Sensoren oder Schnittstellen für Apache Airflow schreiben. Weitere Informationen finden Sie unter Benutzerdefinierte Plug-ins in der Airflow-Dokumentation. Auf dieser Seite wird das Installieren von benutzerdefinierten Plug-ins in einer Cloud Composer-Umgebung erläutert.

Wenn Sie eine Umgebung erstellen, wird von Cloud Composer ein Cloud Storage-Bucket angelegt und Ihrer Umgebung zugeordnet. Zum Installieren von benutzerdefinierten Plug-ins verwenden Sie den Ordner plugins im zugeordneten Bucket.

Hinweise

  • Ihr Konto muss eine Rolle haben, mit der der Bucket-Inhalt Ihrer Umgebung aufgerufen und angepasst werden kann.
  • Diese Installationsmethode gilt nur für Airflow-Plug-ins. Sie können diese Methode beispielsweise nicht verwenden, um gängige Python-Module oder andere Bibliotheken zu installieren.
  • Plug-ins müssen den Richtlinien für Airflow-Plug-in-Vorlagen entsprechen.

Plug-ins installieren

Zum Installieren eines benutzerdefinierten Plug-ins in Ihrer Cloud Composer-Umgebung kopieren Sie den Plug-in-Code in den Ordner plugins im Cloud Storage-Bucket Ihrer Cloud Composer-Umgebung.

So installieren Sie Plug-ins:

Console

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

    Zur Seite Umgebungen“

  2. Suchen Sie Ihre Umgebung und folgen Sie dem Link DAGs.

  3. Gehen Sie eine Ordnerebene nach oben und wechseln Sie zum Ordner plugins/.

  4. Laden Sie die Plug-in-Dateien hoch. Weitere Informationen zum Hochladen von Objekten finden Sie unter Objekte hochladen.

gcloud

Verwenden Sie den folgenden gcloud-Befehl:

gcloud composer environments storage plugins import \
    --environment ENVIRONMENT_NAME \
    --location LOCATION \
    --source PATH_TO_LOCAL_FILE \
    --destination PATH_IN_SUBFOLDER

Ersetzen Sie:

  • ENVIRONMENT_NAME durch den Namen der Umgebung.
  • LOCATION durch die Region, in der sich die Umgebung befindet.
  • PATH_TO_LOCAL_FILE durch den Pfad der hochzuladenden Datei.
  • (Optional) PATH_IN_SUBFOLDER durch den Pfad zum Unterordner. Verwenden Sie das Argument --destination, um ein Plug-in in einen Unterordner im Ordner plugins hochzuladen. Andernfalls lassen Sie das Argument --destination weg.

Liste der Plug-ins aufrufen

Console

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

    Zur Seite Umgebungen“

  2. Suchen Sie Ihre Umgebung und folgen Sie dem Link DAGs.

  3. Gehen Sie eine Ordnerebene nach oben und wechseln Sie zum Ordner plugins/.

  4. Sehen Sie sich die Plug-in-Dateien an.

gcloud

Verwenden Sie den folgenden gcloud-Befehl:

gcloud composer environments storage plugins list \
    --environment ENVIRONMENT_NAME \
    --location LOCATION

Ersetzen Sie:

  • ENVIRONMENT_NAME durch den Namen der Umgebung.
  • LOCATION durch die Region, in der sich die Umgebung befindet.

Plug-in löschen

Wenn Sie ein Plug-in aus Ihrer Cloud Composer-Umgebung entfernen möchten, löschen Sie den Plug-in-Code aus dem Ordner plugins im Bucket der Umgebung.

So löschen Sie ein Plug-in:

Console

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

    Zur Seite Umgebungen“

  2. Suchen Sie Ihre Umgebung und folgen Sie dem Link DAGs.

  3. Gehen Sie eine Ordnerebene nach oben und wechseln Sie zum Ordner plugins/.

  4. Löschen Sie die Plug-in-Dateien. Weitere Informationen zum Löschen von Objekten finden Sie unter Objekte löschen.

gcloud

Verwenden Sie den folgenden gcloud-Befehl:

gcloud composer environments storage plugins delete \
    --environment ENVIRONMENT_NAME \
    --location LOCATION \
    PLUGIN_TO_DELETE

Plug-ins herunterladen

Zum Herunterladen von Plug-ins wählen Sie eine Option aus:

Console

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

    Zur Seite Umgebungen“

  2. Suchen Sie Ihre Umgebung und folgen Sie dem Link DAGs.

  3. Gehen Sie eine Ordnerebene nach oben und wechseln Sie zum Ordner plugins/.

  4. Laden Sie die Plug-in-Dateien herunter. Weitere Informationen zum Löschen von Objekten finden Sie unter Objekte herunterladen.

gcloud

Verwenden Sie den folgenden gcloud-Befehl:

gcloud composer environments storage plugins export \
  --environment ENVIRONMENT_NAME \
  --location LOCATION \
  --destination PATH_TO_LOCAL_DESTINATION \
  --source PATH_IN_FOLDER

Ersetzen Sie:

  • ENVIRONMENT_NAME durch den Namen der Umgebung.
  • LOCATION durch die Region, in der sich die Umgebung befindet.
  • PATH_TO_LOCAL_DESTINATION durch das Ziel für die heruntergeladene Datei.
  • --source ist eine Option zum Herunterladen nur eines Plug-ins. PATH_IN_FOLDER ist der Ordnerpfad.

Fehlerbehebung bei Problemen mit dem Plug-in

Ein neu hochgeladenes Plug-in wird in der Airflow-UI nicht angezeigt

Wenn Sie die Airflow-UI-Zugriffssteuerung verwenden, ist das neu hochgeladene Plug-in möglicherweise nicht in der Airflow-UI sichtbar. Bitten Sie den Airflow-UI-Administrator, den Zugriff auf das neu hochgeladene Plug-in zu konfigurieren, oder weisen Sie sich in der Airflow-UI die Rolle Admin zu, um dieses Problem zu beheben.

Nächste Schritte