Installa le dipendenze Python per Cloud Composer

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Questa pagina descrive come installare i pacchetti Python per il tuo ambiente Cloud Composer.

Informazioni sui pacchetti PyPI preinstallati e personalizzati nelle immagini di Cloud Composer

Le immagini Cloud Composer contengono PyPI preinstallati e personalizzati .

• I pacchetti PyPI preinstallati sono pacchetti inclusi nella l'immagine Cloud Composer del tuo ambiente. Ogni immagine Cloud Composer contiene pacchetti PyPI che sono specifici per la tua versione di Cloud Composer e Airflow.

• I pacchetti PyPI personalizzati sono pacchetti che puoi installare nel tuo ambiente oltre ai pacchetti preinstallati.

Nota: se prevedi di eseguire l'upgrade a una versione successiva di Cloud Composer, puoi eseguire un controllo di upgrade. Questo controllo segnala se i pacchetti PyPI personalizzati nel tuo ambiente presentano conflitti con i pacchetti preinstallati nella nuova immagine di Cloud Composer.

Opzioni per gestire i pacchetti PyPI per gli ambienti Cloud Composer

Opzione	Da utilizzare se
Installare da PyPI	Il modo predefinito per installare i pacchetti nel tuo ambiente
Installazione da un repository con un indirizzo IP pubblico	Il pacchetto è ospitato in un repository di pacchetti diverso da PyPI. Questo repository ha un indirizzo IP pubblico
Installare da un repository Artifact Registry	Il pacchetto è ospitato in un repository Artifact Registry
Installare da un repository nella rete del progetto	Il tuo ambiente non ha accesso alla rete internet pubblica. Il pacchetto è ospitata in un repository di pacchetti nella rete del progetto.
Installa come libreria Python locale	Il pacchetto non è disponibile in PyPI e la libreria non ha dipendenze esterne, ad esempio dist-packages.
Installare un plug-in	Il pacchetto fornisce funzionalità specifiche del plug-in, come la modifica dell'interfaccia web di Airflow.
PythonVirtualenvOperator	Non vuoi che il pacchetto venga installato per tutti i worker Airflow oppure le dipendenze sono in conflitto con i pacchetti preinstallati. Il pacchetto disponibile in PyPI e non ha dipendenze esterne.
KubernetesPodOperator e operatori GKE	Hai bisogno di dipendenze esterne che non possono essere installate da pip, come dist-packages o che si trovano su un server pip interno. Questo richiede più configurazione e manutenzione. Valuta questa opzione solo se le altre non funzionano.

Prima di iniziare

• Devi disporre di un ruolo che possa attivare le operazioni di aggiornamento dell'ambiente. Inoltre, l'account di servizio dell'ambiente deve avere un ruolo con autorizzazioni sufficienti per eseguire operazioni di aggiornamento. Per ulteriori informazioni, consulta Controllo dell'accesso.
• Se il tuo ambiente è protetto da un perimetro dei Controlli di servizio VPC, prima di installare le dipendenze PyPI devi concedere identità utente aggiuntive con accesso ai servizi protetti dal perimetro di servizio e attivare il supporto per un repository PyPI privato.
• I requisiti devono rispettare il formato specificato nella PEP-508 in cui ogni requisito è specificato in minuscolo e consiste nel pacchetto un nome con extra facoltativi e specificatori di versione.

• Gli aggiornamenti delle dipendenze PyPI generano immagini Docker in Artifact Registry.

  Avviso: Non modificare o eliminare le immagini create da Cloud Composer in Artifact Registry o nel repository stesso. Non caricare le tue immagini nel repository. Crea e gestisci invece il tuo repository per le tue immagini (ad esempio per le immagini utilizzate da KubernetesPodOperator). Azioni sconsigliate di eliminare il repository autonomamente. Il repository viene eliminato dopo l'eliminazione nel tuo ambiente.

• Se un conflitto di dipendenze causa la mancata riuscita dell'aggiornamento, il tuo ambiente continua a essere eseguito con le dipendenze esistenti. Se l'operazione riesce, puoi iniziare a utilizzare le dipendenze Python appena installate nei DAG.

• Se vuoi che le tue build per l'esecuzione con un account di servizio personalizzato, puoi eseguire l'override COMPOSER_AGENT_BUILD_SERVICE_ACCOUNT variabile di ambiente con l'account di servizio scelto. Questo account di servizio deve essere configurato per eseguire build in base alla documentazione di Cloud Build, e l'account di servizio dell'ambiente deve avere iam.serviceAccounts.actAs.

• Progetti in cui L'API Cloud Composer è abilitata dal 29 aprile 2024 in poi. A meno che la tua organizzazione non sostituisca constraints/cloudbuild.disableCreateDefaultServiceAccount criterio, nuovi progetti non eseguirà il provisioning dell'account di servizio Cloud Build legacy sull'abilitazione dell'API. Poiché Cloud Build viene utilizzato per impostazione predefinita durante l'installazione di pacchetti PyPI personalizzati nell'ambiente Cloud Composer, l'installazione dei pacchetti potrebbe non riuscire. Per impostazione predefinita, verrà utilizzato il service account dell'ambiente, quindi assicurati di concedere anche a questo account di servizio le autorizzazioni aggiuntive necessarie per accedere ai pacchetti privati.

Visualizza l'elenco dei pacchetti PyPI

Puoi ottenere l'elenco dei pacchetti per il tuo ambiente in diversi formati.

Visualizza pacchetti preinstallati

Per visualizzare l'elenco dei pacchetti preinstallati per il tuo ambiente, vedi l'elenco dei pacchetti Immagine Cloud Composer del tuo ambiente.

Visualizza tutti i pacchetti

Per visualizzare tutti i pacchetti (preinstallati e personalizzati) nel tuo ambiente:

gcloud

Il seguente comando gcloud CLI restituisce il risultato del comando python -m pip list per un worker Airflow nel tuo ambiente. Puoi utilizzare l'argomento --tree per ottenere il risultato del comando python -m pipdeptree --warn.

gcloud beta composer environments list-packages \
    ENVIRONMENT_NAME \
    --location LOCATION

Sostituisci:

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

Visualizzare i pacchetti PyPI personalizzati

Console

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

   Vai ad Ambienti

2. Nell'elenco degli ambienti, fai clic sul nome dell'ambiente. Viene visualizzata la pagina Dettagli dell'ambiente.

3. Apri la scheda Pacchetti PyPI.

gcloud

gcloud composer environments describe ENVIRONMENT_NAME \
  --location LOCATION \
  --format="value(config.softwareConfig.pypiPackages)"

Sostituisci:

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

Installare pacchetti personalizzati in un ambiente Cloud Composer

Questa sezione descrive diversi metodi per installare pacchetti personalizzati nel tuo ambiente.

Installa pacchetti da PyPI

Un pacchetto può essere installato dal Python Package Index se non ha dipendenze esterne o conflitti con i pacchetti preinstallati.

Nota: puoi allentare i vincoli di versione per i pacchetti PyPI personalizzati installati. Ad esempio, anziché specificare una versione come ==1.0.1, specificala come >=1.0.1.

Per aggiungere, aggiornare o eliminare le dipendenze Python per il tuo ambiente:

Console

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

   Vai ad Ambienti

2. Nell'elenco degli ambienti, fai clic sul nome dell'ambiente. Viene visualizzata la pagina Dettagli dell'ambiente.

3. Vai alla scheda Pacchetti PyPI.

4. Fai clic su "Modifica".

5. Fai clic su Aggiungi pacchetto.

6. Nella sezione Pacchetti PyPI, specifica i nomi dei pacchetti, con ed extra di versione.

   Ad esempio:

   • scikit-learn
   • scipy, >=0.13.3
   • nltk, [machine_learning]

7. Fai clic su Salva.

gcloud

L'interfaccia a riga di comando gcloud ha diversi argomenti per lavorare con i pacchetti PyPI personalizzati:

• --update-pypi-packages-from-file sostituisce tutti i pacchetti personalizzati PyPI esistenti con i pacchetti specificati. I pacchetti che non specifichi vengono rimossi.
• --update-pypi-package aggiorna o installa un pacchetto.
• --remove-pypi-packages rimuove i pacchetti specificati.
• --clear-pypi-packages rimuove tutti i pacchetti.

Requisiti di installazione da un file

Il file requirements.txt deve avere ogni specificatore dei requisiti su una riga distinta.

Ad esempio:

scipy>=0.13.3
scikit-learn
nltk[machine_learning]

Aggiorna l'ambiente e specifica il file requirements.txt in dall'argomento --update-pypi-packages-from-file.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --update-pypi-packages-from-file requirements.txt

Sostituisci:

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

Installazione di un pacchetto

Aggiorna l'ambiente e specifica il pacchetto, la versione e gli extra in l'argomento --update-pypi-package.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --update-pypi-package PACKAGE_NAMEEXTRAS_AND_VERSION

Sostituisci:

• ENVIRONMENT_NAME con il nome dell'ambiente.
• LOCATION con la regione in cui si trova l'ambiente.
• PACKAGE_NAME con il nome del pacchetto.
• EXTRAS_AND_VERSION con l'indicatore facoltativo versione e extra. Per ommettere le versioni e gli extra, specifica un valore vuoto.

Nota: a seconda dell'ambiente di esecuzione, potrebbe essere necessario eseguire l'escape di caratteri speciali come >. Per evitare potenziali problemi, racchiudi tra virgolette il nome e la versione del pacchetto, ad esempio: "scipy>=0.13.0".

Esempio:

gcloud composer environments update example-environment \
    --location us-central1 \
    --update-pypi-package "scipy>=0.13.3"

Rimuovere i pacchetti

Aggiorna il tuo ambiente e specifica i pacchetti che vuoi eliminare nell'argomento --remove-pypi-packages:

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
     --remove-pypi-packages PACKAGE_NAMES

Sostituisci:

• ENVIRONMENT_NAME con il nome dell'ambiente.
• LOCATION con la regione in cui si trova l'ambiente.
• PACKAGE_NAMES con un elenco di pacchetti separati da virgole.

Esempio:

gcloud composer environments update example-environment \
    --location us-central1 \
    --remove-pypi-packages scipy,scikit-learn

API

Creare una richiesta API environments.patch.

In questa richiesta:

1. Nel parametro updateMask, specifica la maschera:

   • Utilizza la maschera config.softwareConfig.pypiPackages per sostituire tutti quelli esistenti di pacchetti con i pacchetti specificati. I pacchetti che non specifichi vengono eliminati.
   • Usa config.softwareConfig.envVariables.PACKAGE_NAME per aggiungere o aggiornare un pacchetto specifico. Per aggiungere o aggiornare diversi pacchetti, specificare diverse maschere con virgole.

2. Nel corpo della richiesta, specifica i pacchetti e i valori per le versioni e gli extra:

   {
     "config": {
       "softwareConfig": {
         "pypiPackages": {
           "PACKAGE_NAME": "EXTRAS_AND_VERSION"
         }
       }
     }
   }
   

   Sostituisci:

   • PACKAGE_NAME con il nome del pacchetto.
   • EXTRAS_AND_VERSION con l'indicatore facoltativo versione e extra. Per ommettere le versioni e gli extra, specifica un valore vuoto.
   • Per aggiungere più di un pacchetto, inserisci altre voci per i pacchetti. a pypiPackages.

Esempio:

// PATCH https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.softwareConfig.pypiPackages.EXAMPLE_PACKAGE,
// config.softwareConfig.pypiPackages.ANOTHER_PACKAGE
{
  "config": {
    "softwareConfig": {
      "pypiPackages": {
        "EXAMPLE_PACKAGE": "",
        "ANOTHER_PACKAGE": ">=1.10.3"
      }
    }
  }
}

Terraform

Il blocco pypi_packages nel blocco software_config specifica .

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

  config {

    software_config {

      pypi_packages = {
          PACKAGE_NAME = "EXTRAS_AND_VERSION"
      }

    }
  }
}

Sostituisci:

• ENVIRONMENT_NAME con il nome dell'ambiente.
• LOCATION con la regione in cui si trova l'ambiente.
• PACKAGE_NAME con il nome del pacchetto.
• EXTRAS_AND_VERSION con il selettore facoltativo di versione ed extra. Per ommettere le versioni e gli extra, specifica un valore vuoto.
• Per aggiungere più di un pacchetto, aggiungi voci aggiuntive per i pacchetti a pypi_packages.

Esempio:

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

  config {

    software_config {
      pypi_packages = {
          scipy = ">=1.10.3"
          scikit-learn = ""
          nltk = "[machine_learning]"
      }
    }
  }
}

Installa pacchetti da un repository pubblico

Puoi installare pacchetti ospitati in altri repository che hanno un indirizzo IP pubblico.

I pacchetti devono essere configurati correttamente, in modo che lo strumento pip predefinito possa installarli.

Nota: Cloud Composer non supporta la personalizzazione di pip e non risolve le dipendenze e i conflitti dei pacchetti al di fuori dei meccanismi di risoluzione forniti dallo strumento pip predefinito.

Per installare da un repository di pacchetti con un indirizzo pubblico:

1. Crea un file pip.conf e includi le seguenti informazioni, se applicabili:

   • URL del repository (nel parametro index-url)
   • Credenziali di accesso per il repository
   • Opzioni di installazione non predefinite di pip

   Esempio:

   [global]
   index-url=https://example.com/
   

2. (Facoltativo) In alcuni casi, potresti voler recuperare i pacchetti da più repository, ad esempio quando il repository pubblico contiene alcuni pacchetti specifici che vuoi installare e vuoi installare tutti gli altri pacchetti da PyPI:

   1. Configura un repository virtuale Artifact Registry.
   2. Aggiungi la configurazione per più repository (incluso PyPI, se necessario) e definisci l'ordine in cui pip esegue la ricerca nei repository.
   3. Specifica l'URL del repository virtuale nel parametro index-url.

3. Determina l'URI del bucket del tuo ambiente.

4. Carica il file pip.conf nel file /config/pip/ cartella nel bucket dell'ambiente.

5. Installa i pacchetti utilizzando uno dei metodi disponibili.

Installa pacchetti da un repository Artifact Registry

Puoi archiviare i pacchetti in un repository Artifact Registry nel tuo progetto e configurare l'ambiente per l'installazione da lì.

Nota: se utilizzi Controlli di servizio VPC, crea il repository PyPI di Artifact Registry in modalità VPC. Nella in questo caso, segui le procedura per repository privati durante l'assegnazione autorizzazioni aggiuntive.

Configura i ruoli e le autorizzazioni:

1. L'account di servizio del tuo ambiente deve avere il ruolo iam.serviceAccountUser.

2. Assicurati che l'account di servizio Cloud Build disponga delle autorizzazioni per leggere dal repository Artifact Registry.

3. Se il tuo ambiente ha limitato l'accesso ad altri servizi in progetto, ad esempio, se utilizzi Controlli di servizio VPC:

   1. Assegna le autorizzazioni per accedere al repository Artifact Registry per l'account di servizio dell'ambiente anziché Account di servizio Cloud Build.

   2. Assicurati che la connettività al repository Artifact Registry sia configurata nel progetto.

Per installare pacchetti PyPI personalizzati da un repository Artifact Registry:

1. Crea un file pip.conf e includi le seguenti informazioni nel file, se applicabile:

   • URL del repository Artifact Registry (nel parametro index-url)
   • Credenziali di accesso per il repository
   • Opzioni di installazione non predefinite di pip

   Per un repository Artifact Registry, aggiungi /simple/ al repository URL:

   [global]
   index-url = https://us-central1-python.pkg.dev/example-project/example-repository/simple/
   

2. (Facoltativo) In alcuni casi, potresti voler recuperare i pacchetti da più repository, ad esempio quando il repository Artifact Registry contiene alcuni pacchetti specifici che vuoi installare e vuoi installare tutti gli altri pacchetti da PyPI:

   1. Configura un repository virtuale Artifact Registry.
   2. Aggiungi la configurazione per più repository (incluso PyPI, se necessario) e definisci l'ordine in cui pip esegue la ricerca nei repository.
   3. Specifica l'URL del repository virtuale nel parametro index-url.

3. Carica questo file pip.conf nella cartella /config/pip/ nel bucket del tuo ambiente. Ad esempio: gs://us-central1-example-bucket/config/pip/pip.conf.

4. Installa i pacchetti utilizzando uno dei metodi disponibili.

Installare pacchetti da un repository privato

Puoi ospitare un repository privato nella rete del tuo progetto e configurare il tuo ambiente per installare i pacchetti Python.

Configura i ruoli e le autorizzazioni:

1. L'account di servizio per l'ambiente Cloud Composer deve avere il ruolo iam.serviceAccountUser.

2. Se installi pacchetti PyPI personalizzati da un repository nella cartella e questo repository non ha un indirizzo IP pubblico:

   1. Assegna le autorizzazioni per accedere a questo repository agli l'account di servizio.

   2. Assicurati che la connettività a questo repository sia configurata nel progetto.

Per installare i pacchetti da un repository privato ospitato nella rete del progetto:

1. Crea un file pip.conf e includi le seguenti informazioni, se applicabili:

   • Indirizzo IP del repository nella rete del progetto
   • Credenziali di accesso per il repository
   • Opzioni di installazione non predefinite di pip

   Esempio:

   [global]
   index-url=https://192.0.2.10/
   

2. (Facoltativo) In alcuni casi, potresti voler recuperare i pacchetti da più repository, ad esempio quando il repository privato contiene alcuni pacchetti specifici che vuoi installare e vuoi installare tutti gli altri pacchetti da PyPI:

   1. Configura un repository virtuale Artifact Registry.
   2. Aggiungi la configurazione per più repository (incluso PyPI, se necessario) e definisci l'ordine in cui pip cerca nei repository.
   3. Specifica l'URL del repository virtuale nel parametro index-url.

3. (Facoltativo) Nella versione 2.2.1 e versioni successive di Cloud Composer, puoi: utilizza un certificato personalizzato durante l'installazione di pacchetti dal tuo repository Git. Ecco come fare:

   1. Carica il file del certificato nel /config/pip/ nel bucket dell'ambiente.

      Attenzione: non caricare chiavi private. Carica solo un file pubblico in un pacchetto di certificati in formato PEM. Verifica che il certificato che contiene la CA radice corretta.

   2. In pip.conf, specifica il nome del file del certificato nel parametro cert. Non modificare la cartella /etc/pip/.

      Esempio:

      [global]
      cert =/etc/pip/example-certificate.pem
      

4. Carica il file pip.conf nel file /config/pip/ cartella nel bucket dell'ambiente. Ad esempio: gs://us-central1-example-bucket/config/pip/pip.conf.

5. Installa i pacchetti utilizzando uno dei metodi disponibili.

Installa una libreria Python locale

Per installare una libreria Python interna o locale:

1. Inserisci le dipendenze in una sottodirectory della cartella dags/ nel bucket del tuo ambiente. Per importare un modulo da una sottodirectory, ogni sottodirectory nel percorso del modulo deve contenere un __init__.py file indicatore del pacchetto.

   Nell'esempio seguente, la dipendenza è coin_module.py:

   dags/
     use_local_deps.py  # A DAG file.
     dependencies/
       __init__.py
       coin_module.py
   

2. Importa la dipendenza dal file di definizione del DAG.

   Ad esempio:

from dependencies import coin_module

Nota: si verifica un errore di importazione se manca un file __init__.py. I nomi di directory e file devono essere identificatori Python validi.

Utilizzare pacchetti che dipendono da librerie di oggetti condivisi

Alcuni pacchetti PyPI dipendono da librerie a livello di sistema. Sebbene Cloud Composer non supporti le librerie di sistema, puoi utilizzare le seguenti opzioni:

• Utilizza KubernetesPodOperator. Imposta l'immagine dell'operatore su una l'immagine build. Se si verificano pacchetti che non funzionano durante l'installazione a causa a una dipendenza dal sistema non soddisfatta, utilizza questa opzione.

• Carica le librerie di oggetti condivise nel bucket del tuo ambiente. Se il tuo PyPI i pacchetti sono stati installati correttamente, ma non in fase di runtime. Utilizza questa opzione.

  1. Trova manualmente le librerie di oggetti condivisi per la dipendenza PyPI (un file .so).
  2. Carica le librerie di oggetti condivisi nella cartella /plugins del bucket del tuo ambiente.
  3. Imposta la seguente variabile di ambiente: LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/airflow/gcs/plugins

Nota: i file nelle cartelle plugins/ vengono sincronizzati con il file system locale. Caricamento di file .so di grandi dimensioni possono influire sulle prestazioni del tuo ambiente e del server web Airflow.

Installare pacchetti in ambienti IP privati

Questa sezione spiega come installare i pacchetti in ambienti IP privati.

A seconda di come configuri il progetto, l'ambiente potrebbe non avere l'accesso alla rete internet pubblica.

Ambiente IP privato con accesso a internet pubblico

Se il tuo ambiente IP privato può accedere a internet pubblico, puoi installare i pacchetti utilizzando le opzioni per gli ambienti IP pubblici:

• Installa da PyPI. In questo caso, non è richiesta alcuna configurazione speciale. Segui la procedura descritta in Installa un pacchetto da PyPI.
• Installa da un repository con un indirizzo IP pubblico. Segui la procedura descritta in Installa un pacchetto da un repository privato.
• Installa da un repository PyPI privato ospitato nella rete del progetto.

Ambiente IP privato senza accesso a internet

Se il tuo ambiente IP privato non ha accesso a internet pubblico, puoi installare i pacchetti in uno dei seguenti modi:

• Utilizza un repository PyPI privato ospitato nel repository in ogni rete.
• Utilizza una VM server proxy nella rete del progetto per connetterti a un repository PyPI sulla rete internet pubblica. Specifica l'indirizzo del proxy nel file /config/pip/pip.conf nel bucket dell'ambiente.
• Utilizza un repository Artifact Registry come unica fonte di pacchetti. Per farlo, ridefinisci il parametro index-url, come descritto.
• Se il criterio di sicurezza consente l'accesso a indirizzi IP esterni dal tuo rete VPC, puoi abilitare l'installazione di pacchetti dai repository sulla rete internet pubblica configurando Cloud NAT.
• Inserisci le dipendenze Python nella cartella /dags del bucket del tuo ambiente per installarle come librerie locali. Questa potrebbe non essere un'opzione valida se l'albero delle dipendenze è di grandi dimensioni.

Installazione in un ambiente IP privato con restrizioni sulla località delle risorse

Mantenere il progetto in linea con la restrizione sulla località delle risorse requisiti impediscono l'uso di alcuni strumenti. In particolare, Cloud Build non può essere utilizzato per l'installazione di pacchetti, impedendo l'accesso diretto dei repository sulla rete internet pubblica.

Per installare le dipendenze Python in un ambiente di questo tipo, segui le indicazioni per un ambiente IP privato senza accesso a internet.

Installa una dipendenza Python in un ambiente IP privato in un perimetro dei Controlli di servizio VPC

La protezione del progetto con un perimetro di Controlli di servizio VPC comporta ulteriori limitazioni di sicurezza. In particolare, Cloud Build non può essere utilizzato per l'installazione di pacchetti, impedendo l'accesso diretto dei repository sulla rete internet pubblica.

Per installare le dipendenze Python per un ambiente IP privato all'interno di un perimetro, segui le indicazioni per gli ambienti IP privati senza accesso a internet.

Passaggi successivi

• Risoluzione dei problemi relativi all'installazione del pacchetto
• Risolvere i problemi relativi ad aggiornamenti e upgrade