Installazione di plug-in personalizzati

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Questa pagina descrive come installare plug-in personalizzati nel tuo ambiente Cloud Composer.

Il gestore dei plug-in di Apache Airflow consente di scrivere operatori, hook, sensori o interfacce interni personalizzati di Apache Airflow. Per ulteriori informazioni, consulta i plug-in personalizzati nella documentazione di Airflow.

Informazioni sui plug-in personalizzati

Quando crei un ambiente, Cloud Composer crea un bucket Cloud Storage e lo associa al tuo ambiente. Utilizza la cartella plugins nel bucket del tuo ambiente per installare plug-in personalizzati.

Prima di iniziare

  • Il tuo account deve avere un ruolo che consenta di visualizzare e modificare i contenuti dei bucket dell'ambiente.
  • Questo metodo di installazione si applica solo ai plug-in Airflow. Ad esempio, non puoi utilizzare questo metodo per installare moduli Python comuni o altre librerie.
  • I plug-in devono essere conformi alle linee guida relative al modello di plug-in Airflow.

Installa un plug-in

Per installare un plug-in personalizzato nel tuo ambiente Cloud Composer, copia il codice del plug-in nella cartella plugins del bucket dell'ambiente.

Per installare un plug-in:

Console

  1. Nella console Google Cloud, vai alla pagina Ambienti.

    Vai ad Ambienti

  2. Trova il tuo ambiente e segui il link DAG.

  3. Sali di livello superiore, quindi passa alla cartella plugins/.

  4. Carica i file dei tuoi plug-in. Per ulteriori informazioni sul caricamento di oggetti, consulta Caricamento di oggetti.

gcloud

Usa questo comando gcloud:

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

Sostituisci:

  • ENVIRONMENT_NAME con il nome dell'ambiente.
  • LOCATION con la regione in cui si trova l'ambiente.
  • PATH_TO_LOCAL_FILE con il percorso del file da caricare.
  • (Facoltativo) PATH_IN_SUBFOLDER con il percorso della sottocartella. Utilizza l'argomento --destination per caricare un plug-in in una sottocartella della cartella plugins. In caso contrario, ometti l'argomento --destination.

Visualizza l'elenco dei plug-in

Console

  1. Nella console Google Cloud, vai alla pagina Ambienti.

    Vai ad Ambienti

  2. Trova il tuo ambiente e segui il link DAG.

  3. Sali di livello superiore, quindi passa alla cartella plugins/.

  4. Visualizza i file dei plug-in.

gcloud

Usa questo comando gcloud:

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

Sostituisci:

  • ENVIRONMENT_NAME con il nome dell'ambiente.
  • LOCATION con la regione in cui si trova l'ambiente.

Eliminare un plug-in

Per eliminare un plug-in dal tuo ambiente Cloud Composer, elimina il codice del plug-in dalla cartella plugins nel bucket dell'ambiente.

Per eliminare un plug-in:

Console

  1. Nella console Google Cloud, vai alla pagina Ambienti.

    Vai ad Ambienti

  2. Trova il tuo ambiente e segui il link DAG.

  3. Sali di livello superiore, quindi passa alla cartella plugins/.

  4. Elimina i file dei plug-in. Per ulteriori informazioni sull'eliminazione degli oggetti, consulta Eliminazione di oggetti.

gcloud

Usa questo comando gcloud:

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

Scarica plug-in

Per scaricare i plug-in, scegli un'opzione:

Console

  1. Nella console Google Cloud, vai alla pagina Ambienti.

    Vai ad Ambienti

  2. Trova il tuo ambiente e segui il link DAG.

  3. Sali di livello superiore, quindi passa alla cartella plugins/.

  4. Scarica i file dei plug-in. Per ulteriori informazioni sull'eliminazione di oggetti, consulta Download di oggetti.

gcloud

Usa questo comando gcloud:

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

Sostituisci:

  • ENVIRONMENT_NAME con il nome dell'ambiente.
  • LOCATION con la regione in cui si trova l'ambiente.
  • PATH_TO_LOCAL_DESTINATION con la destinazione del file scaricato.
  • (Facoltativo) --source è un'opzione per scaricare un solo plug-in. PATH_IN_FOLDER è il percorso della cartella.

Risoluzione dei problemi relativi ai plug-in

I plug-in causano problemi con la UI di Airflow

Puoi disattivare i plug-in dei server web senza eliminarli. Per maggiori informazioni, consulta l'articolo Disattivare i plug-in dei server web.

Un plug-in appena caricato non è visibile nella UI di Airflow

Se utilizzi il controllo dell'accesso all'interfaccia utente di Airflow, il plug-in appena caricato potrebbe non essere visibile nella UI di Airflow. Per risolvere questo problema, chiedi all'amministratore dell'interfaccia utente di Airflow di configurare l'accesso al plug-in appena caricato o di assegnarti il ruolo Admin nella UI di Airflow.

Passaggi successivi