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 Cloud Composer
Le immagini Cloud Composer contengono pacchetti PyPI preinstallati e personalizzati.
I pacchetti PyPI preinstallati sono pacchetti inclusi nell'immagine Cloud Composer del tuo ambiente. Ogni immagine di Cloud Composer contiene pacchetti PyPI 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.
Opzioni per gestire i pacchetti PyPI per gli ambienti Cloud Composer
Opzione | Da utilizzare se |
---|---|
Installa 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 |
Installazione da un repository Artifact Registry | Il pacchetto è ospitato in un repository Artifact Registry |
Installazione da un repository nella rete del progetto | Il tuo ambiente non ha accesso alla rete internet pubblica. Il pacchetto è ospitato in un repository di pacchetti nella rete del progetto. |
Installa come libreria Python locale |
Impossibile trovare il pacchetto in PyPI e la libreria non ha dipendenze esterne, ad esempio dist-packages . |
Installare un plug-in | Il pacchetto fornisce funzionalità specifiche per i plug-in, come la modifica dell'interfaccia web di Airflow. |
PythonVirtualenvOperator | Non vuoi che il pacchetto venga installato per tutti i worker di Airflow, altrimenti le dipendenze sono in conflitto con pacchetti preinstallati. Il pacchetto si trova in PyPI e non ha dipendenze esterne. |
KubernetesPodOperator e operatori GKE |
Sono necessarie dipendenze esterne che non possono essere installate da pip , ad esempio dist-packages , o che si trovano su un server pip interno. Questa opzione richiede
maggiori operazioni di configurazione e manutenzione. Prendi in considerazione solo se
le altre opzioni non funzionano. |
Prima di iniziare
- Devi avere un ruolo in grado di 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 maggiori informazioni, vedi Controllo dell'accesso.
- Se il tuo ambiente è protetto da un perimetro dei Controlli di servizio VPC, prima di installare le dipendenze PyPI devi concedere ulteriori identità utente con accesso ai servizi che il perimetro di servizio protegge e abilitare il supporto per un repository PyPI privato.
- I requisiti devono rispettare il formato specificato in PEP-508, in cui ogni requisito è specificato in minuscolo ed è costituito dal nome del pacchetto con extra facoltativi e specifici di versione.
Gli aggiornamenti delle dipendenze PyPI generano immagini Docker in Artifact Registry.
Se un conflitto di dipendenze causa la mancata riuscita dell'aggiornamento, l'ambiente continua a essere eseguito con le dipendenze esistenti. Se l'operazione riesce, puoi iniziare a utilizzare le dipendenze Python appena installate nei tuoi DAG.
Visualizza l'elenco dei pacchetti PyPI
È possibile 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 per l'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.
Visualizza pacchetti PyPI personalizzati
Console
Nella console Google Cloud, vai alla pagina Ambienti.
Nell'elenco degli ambienti, fai clic sul nome dell'ambiente. Si apre la pagina Dettagli ambiente.
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.
Installa pacchetti personalizzati in un ambiente Cloud Composer
Questa sezione descrive i diversi metodi per installare pacchetti personalizzati nel tuo ambiente.
Installa pacchetti da PyPI
Un pacchetto può essere installato dall'indice pacchetti Python se non ha dipendenze esterne o conflitti con i pacchetti preinstallati.
Per aggiungere, aggiornare o eliminare le dipendenze Python per il tuo ambiente:
Console
Nella console Google Cloud, vai alla pagina Ambienti.
Nell'elenco degli ambienti, fai clic sul nome dell'ambiente. Si apre la pagina Dettagli ambiente.
Vai alla scheda Pacchetti PyPI.
Fai clic su "Modifica".
Fai clic su Aggiungi pacchetto.
Nella sezione Pacchetti PyPI, specifica i nomi dei pacchetti, con indicatori di versione ed extra facoltativi.
Ad esempio:
scikit-learn
scipy
,>=0.13.3
nltk
,[machine_learning]
Fai clic su Salva.
gcloud
gcloud CLI ha diversi agrumenti per lavorare con i pacchetti PyPI personalizzati:
--update-pypi-packages-from-file
sostituisce tutti i pacchetti PyPI personalizzati esistenti con i pacchetti specificati. I pacchetti che non hai specificato vengono rimossi.--update-pypi-package
aggiorna o installa un pacchetto.--remove-pypi-packages
rimuove i pacchetti specificati.--clear-pypi-packages
rimuove tutti i pacchetti.
Installare i requisiti da un file
Il file requirements.txt
deve avere ogni indicatore di requisito su una riga separata.
Ad esempio:
scipy>=0.13.3
scikit-learn
nltk[machine_learning]
Aggiorna l'ambiente e specifica il file requirements.txt
nell'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
nell'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 omettere le versioni e gli extra, specifica un valore vuoto.
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 da 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:
Nel parametro
updateMask
, specifica la maschera:- Utilizza la maschera
config.softwareConfig.pypiPackages
per sostituire tutti i pacchetti esistenti con i pacchetti specificati. I pacchetti che non hai specificato vengono eliminati. - Utilizza
config.softwareConfig.envVariables.PACKAGE_NAME
per aggiungere o aggiornare un pacchetto specifico. Per aggiungere o aggiornare più pacchetti, specifica diverse maschere con le virgole.
- Utilizza la maschera
Nel corpo della richiesta, specifica pacchetti e 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 omettere le versioni e gli extra, specifica un valore vuoto.- Per aggiungere più di un pacchetto, aggiungi 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 i pacchetti.
resource "google_composer_environment" "example" {
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 l'indicatore facoltativo versione e extra. Per omettere le versioni e gli extra, specifica un valore vuoto.- Per aggiungere più di un pacchetto, aggiungi altre voci per i pacchetti a
pypi_packages
.
Esempio:
resource "google_composer_environment" "example" {
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 per consentire l'installazione dello strumento pip
predefinito.
Per eseguire l'installazione da un repository di pacchetti il cui indirizzo è pubblico:
Crea un file pip.conf e includi le seguenti informazioni, se applicabile:
- 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/
- URL del repository (nel parametro
(Facoltativo) In alcuni casi, potresti voler recuperare pacchetti da più repository, ad esempio quando il repository pubblico contiene alcuni pacchetti specifici da installare e vuoi installare tutti gli altri pacchetti da PyPI:
- Configura un repository virtuale Artifact Registry.
- Aggiungi la configurazione per più repository (incluso PyPI, se necessario)
e definisci l'ordine in cui
pip
cerca nei repository. - Specifica l'URL del repository virtuale nel parametro
index-url
.
Carica il file pip.conf nella cartella
/config/pip/
del bucket del tuo ambiente.Installa i pacchetti usando 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ì.
Configura ruoli e autorizzazioni:
L'account di servizio del tuo ambiente deve avere il ruolo
iam.serviceAccountUser
.Assicurati che l'account di servizio Cloud Build disponga delle autorizzazioni per leggere dal repository Artifact Registry.
Se il tuo ambiente ha limitato l'accesso ad altri servizi nel tuo progetto, ad esempio se utilizzi Controlli di servizio VPC:
Assegna le autorizzazioni per accedere al repository Artifact Registry all'account di servizio dell'ambiente anziché all'account di servizio Cloud Build.
Assicurati che la connettività al repository Artifact Registry sia configurata nel tuo progetto.
Per installare pacchetti PyPI personalizzati da un repository Artifact Registry:
Crea un file pip.conf e includi le seguenti informazioni, 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/
all'URL del repository:[global] index-url = https://us-central1-python.pkg.dev/example-project/example-repository/simple/
- URL del repository Artifact Registry (nel parametro
(Facoltativo) In alcuni casi potresti voler recuperare pacchetti da più repository, ad esempio quando il repository Artifact Registry contiene alcuni pacchetti specifici che vuoi installare e tutti gli altri pacchetti da PyPI:
- Configura un repository virtuale Artifact Registry.
- Aggiungi la configurazione per più repository (incluso PyPI, se necessario)
e definisci l'ordine in cui
pip
cerca nei repository. - Specifica l'URL del repository virtuale nel parametro
index-url
.
Carica questo file pip.conf nella cartella
/config/pip/
del bucket del tuo ambiente. Ad esempio:gs://us-central1-example-bucket/config/pip/pip.conf
.Installa i pacchetti usando uno dei metodi disponibili.
Installa pacchetti da un repository privato
Puoi ospitare un repository privato nella rete del tuo progetto e configurare il tuo ambiente per installare pacchetti Python da lì.
Configura ruoli e autorizzazioni:
L'account di servizio per l'ambiente Cloud Composer deve avere il ruolo
iam.serviceAccountUser
.Se installi pacchetti PyPI personalizzati da un repository nella rete del progetto e il repository non ha un indirizzo IP pubblico:
Assegna le autorizzazioni per accedere a questo repository all'account di servizio dell'ambiente.
Assicurati che la connettività a questo repository sia configurata nel tuo progetto.
Per installare pacchetti da un repository privato ospitato nella rete del tuo progetto:
Crea un file pip.conf e includi le seguenti informazioni, se applicabile:
- 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/
(Facoltativo) In alcuni casi, potresti voler recuperare pacchetti da più repository, ad esempio quando il repository privato contiene alcuni pacchetti specifici da installare e vuoi installare tutti gli altri pacchetti da PyPI:
- Configura un repository virtuale Artifact Registry.
- Aggiungi la configurazione per più repository (incluso PyPI, se necessario)
e definisci l'ordine in cui
pip
cerca nei repository. - Specifica l'URL del repository virtuale nel parametro
index-url
.
Carica il file pip.conf nella cartella
/config/pip/
del bucket del tuo ambiente. Ad esempio:gs://us-central1-example-bucket/config/pip/pip.conf
.Installa i pacchetti usando uno dei metodi disponibili.
Installa una libreria Python locale
Per installare una libreria Python interna o locale:
Inserisci le dipendenze all'interno di una sottodirectory nella cartella
dags/
del bucket del tuo ambiente. Per importare un modulo da una sottodirectory, ogni sottodirectory del percorso del modulo deve contenere un file indicatore di pacchetto__init__.py
.Nell'esempio seguente, la dipendenza è
coin_module.py
:dags/ use_local_deps.py # A DAG file. dependencies/ __init__.py coin_module.py
Importa la dipendenza dal file di definizione del DAG.
Ad esempio:
Usa pacchetti che dipendono da librerie di oggetti condivise
Alcuni pacchetti PyPI dipendono dalle librerie a livello di sistema. Sebbene Cloud Composer non supporti le librerie di sistema, è possibile utilizzare le seguenti opzioni:
Utilizzare KubernetesPodOperator. Imposta l'immagine dell'operatore su un'immagine build personalizzata. Se si verificano pacchetti che non riescono durante l'installazione a causa di una dipendenza dal sistema non soddisfatta, utilizza questa opzione.
Carica le librerie di oggetti condivise nel bucket del tuo ambiente. Se i pacchetti PyPI sono stati installati correttamente, ma non in fase di runtime, utilizza questa opzione.
- Trova manualmente le librerie di oggetti condivise per la dipendenza PyPI (un file .so).
- Carica le librerie di oggetti condivise nella cartella
/plugins
del bucket del tuo ambiente. - Imposta la seguente variabile di ambiente:
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/home/airflow/gcs/plugins
Installa pacchetti in ambienti IP privati
Questa sezione spiega come installare pacchetti in ambienti IP privati.
A seconda di come configuri il progetto, il tuo ambiente potrebbe non avere accesso alla rete internet pubblica.
Ambiente IP privato con accesso a internet pubblico
Se il tuo ambiente IP privato può accedere alla rete internet pubblica, 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 Installare un pacchetto da PyPI.
- Installare da un repository con un indirizzo IP pubblico. Segui la procedura descritta in Installare un pacchetto da un repository privato.
- Esegui l'installazione da un repository PyPI privato ospitato nella rete del tuo progetto.
Ambiente IP privato senza accesso a internet
Se il tuo ambiente IP privato non ha accesso alla rete internet pubblica, puoi installare i pacchetti in uno dei seguenti modi:
- Utilizza un repository PyPI privato ospitato nella rete del tuo progetto.
- Utilizza una VM server proxy nella rete del progetto per connetterti a un repository PyPI sulla rete internet pubblica. Specifica l'indirizzo proxy nel file
/config/pip/pip.conf
nel bucket del tuo ambiente. - Utilizza un repository Artifact Registry come unica origine
dei pacchetti. Per farlo, ridefinisci il parametro
index-url
, come descritto. - Se il criterio di sicurezza consente l'accesso a indirizzi IP esterni dalla tua 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 una buona opzione se l'albero delle dipendenze è di grandi dimensioni.
Installa in un ambiente IP privato in base alle limitazioni relative alle località delle risorse
Mantenere il progetto in linea con i requisiti relativi alla restrizione sulla località delle risorse vieta l'uso di alcuni strumenti. In particolare, Cloud Build non può essere utilizzato per l'installazione dei pacchetti, impedendo l'accesso diretto ai repository sulla rete internet pubblica.
Per installare le dipendenze Python in un ambiente di questo tipo, segui le indicazioni per ambienti IP privati 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 Controlli di servizio VPC comporta ulteriori limitazioni per la sicurezza. In particolare, Cloud Build non può essere utilizzato per l'installazione dei pacchetti, impedendo l'accesso diretto ai 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 di installazione dei pacchetti
- Risolvere i problemi relativi ad aggiornamenti e upgrade