Cloud Composer 1 | Cloud Composer 2
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 di 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 a quelli preinstallati.
Opzioni per gestire i pacchetti PyPI per gli ambienti Cloud Composer
Opzione | Da utilizzare se |
---|---|
Installa da PyPI | Il modo predefinito per installare pacchetti nel tuo ambiente |
Eseguire l'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 |
Eseguire l'installazione da un repository Artifact Registry | Il pacchetto è ospitato in un repository Artifact Registry |
Eseguire l'installazione da un repository nella rete del progetto | Il tuo ambiente non ha accesso a una 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 il plug-in, ad esempio la modifica dell'interfaccia web di Airflow. |
PythonVirtualenvOperator | Non vuoi che il pacchetto venga installato per tutti i worker di Airflow o che la dipendenza sia in conflitto con pacchetti preinstallati. Il pacchetto si trova in PyPI e non ha dipendenze esterne. |
KubernetesPodOperator e operatori GKE |
Hai bisogno di 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 ulteriori operazioni di configurazione e manutenzione. Consideralo solo se le altre
opzioni non funzionano. |
Prima di iniziare
- Devi avere un ruolo che possa attivare 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 seguire il formato specificato in PEP-508, in cui ogni requisito è specificato in minuscolo ed è composto dal nome del pacchetto con extra facoltativi e identificatori di versione.
Gli aggiornamenti delle dipendenze di PyPI generano immagini Docker in Artifact Registry.
Se un conflitto di dipendenze causa la mancata riuscita dell'aggiornamento, l'ambiente continuerà a essere eseguito con le dipendenze esistenti. Se l'operazione ha esito positivo, puoi iniziare a utilizzare le dipendenze Python appena installate nei tuoi DAG.
Progetti in cui l'API Cloud Composer è abilitata a partire dal 29 aprile 2024. A meno che la tua organizzazione non esegua l'override del criterio
constraints/cloudbuild.disableCreateDefaultServiceAccount
, per i nuovi progetti non verrà eseguito il provisioning dell'account di servizio Cloud Build legacy all'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 l'account di servizio dell'ambiente, perciò assicurati di concedere le eventuali autorizzazioni aggiuntive necessarie per accedere ai pacchetti privati anche a quell'account di servizio. Se vuoi che le build vengano eseguite con un account diverso, puoi sostituire la variabile di ambienteCOMPOSER_AGENT_BUILD_SERVICE_ACCOUNT
con l'account di servizio scelto. Questo account di servizio deve essere configurato per l'esecuzione di build in base alla documentazione di Cloud Build e l'account di servizio dell'ambiente deve avere l'autorizzazioneiam.serviceAccounts.actAs
.
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, consulta 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. Viene visualizzata la pagina Dettagli ambiente.
Vai alla 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 dei 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. Viene visualizzata 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 identificatori 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 elementi 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.
Requisiti per l'installazione da un file
Il file requirements.txt
deve avere ogni specificatore dei requisiti su una riga separata.
Ad esempio:
scipy>=0.13.3
scikit-learn
nltk[machine_learning]
Aggiorna il tuo 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 il tuo 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 la versione facoltativa e lo specificatore extra. Per omettere versioni ed extra, specifica un valore vuoto.
Esempio:
gcloud composer environments update example-environment \
--location us-central1 \
--update-pypi-package "scipy>=0.13.3"
Rimozione di 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:
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 più maschere con virgole.
- Utilizza la maschera
Nel corpo della richiesta, specifica i pacchetti e i valori per versioni ed extra:
{ "config": { "softwareConfig": { "pypiPackages": { "PACKAGE_NAME": "EXTRAS_AND_VERSION" } } } }
Sostituisci:
PACKAGE_NAME
con il nome del pacchetto.EXTRAS_AND_VERSION
con la versione facoltativa e lo specificatore extra. Per omettere versioni ed extra, specifica un valore vuoto.- Per aggiungere più di un pacchetto, aggiungi voci extra 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" {
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 la versione facoltativa e lo specificatore extra. Per omettere versioni ed extra, specifica un valore vuoto.- Per aggiungere più di un pacchetto, aggiungi voci extra 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.
Per eseguire l'installazione da un repository di pacchetti con un indirizzo pubblico:
Crea un file pip.conf e includi le seguenti informazioni nel file, se applicabile:
- URL del repository (nel parametro
index-url
) - Credenziali di accesso per il repository
- Opzioni di installazione di
pip
non predefinite
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 se il repository pubblico contiene alcuni pacchetti specifici che vuoi installare e vuoi installare tutti gli altri pacchetti da PyPI:
- Configura un repository virtuale di 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/
nel bucket del tuo ambiente.Installa i pacchetti utilizzando uno dei metodi disponibili.
Installare pacchetti da un repository Artifact Registry
Puoi archiviare i pacchetti in un repository Artifact Registry nel tuo progetto e configurare il tuo ambiente per l'installazione da questo repository.
Configura i ruoli e le 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 accesso limitato ad altri servizi nel progetto, ad esempio se utilizzi Controlli di servizio VPC:
Assegna le autorizzazioni per accedere al tuo 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 nel file, se applicabile:
- URL del repository Artifact Registry (nel parametro
index-url
) - Credenziali di accesso per il repository
- Opzioni di installazione di
pip
non predefinite
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 vuoi installare tutti gli altri pacchetti da PyPI:
- Configura un repository virtuale di 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 utilizzando uno dei metodi disponibili.
Installa pacchetti da un repository privato
Puoi ospitare un repository privato nella rete del progetto e configurare il tuo ambiente per l'installazione dei pacchetti Python.
Configura i ruoli e le autorizzazioni:
L'account di servizio per il tuo 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 progetto:
Crea un file pip.conf e includi le seguenti informazioni nel file, se applicabile:
- Indirizzo IP del repository nella rete del progetto
- Credenziali di accesso per il repository
- Opzioni di installazione di
pip
non predefinite
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 che vuoi installare, e vuoi installare tutti gli altri pacchetti da PyPI:
- Configura un repository virtuale di 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
.
(Facoltativo) Nella versione 2.2.1 e successive di Cloud Composer, puoi utilizzare un certificato personalizzato per installare i pacchetti dal tuo repository privato. Ecco come fare:
Carica il file del certificato nella cartella
/config/pip/
del bucket del tuo ambiente.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
Carica il file pip.conf nella cartella
/config/pip/
nel bucket del tuo ambiente. Ad esempio:gs://us-central1-example-bucket/config/pip/pip.conf
.Installa i pacchetti utilizzando uno dei metodi disponibili.
Installa una libreria Python locale
Per installare una libreria Python interna o locale:
Posiziona le dipendenze in una sottodirectory nella cartella
dags/
nel bucket del tuo ambiente. Per importare un modulo da una sottodirectory, ogni sottodirectory del percorso del modulo deve contenere un file degli indicatori 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 condivisi
Alcuni pacchetti PyPI dipendono da librerie a livello di sistema. Anche se Cloud Composer non supporta le librerie di sistema, puoi utilizzare le seguenti opzioni:
Utilizza KubernetesPodOperator. Imposta l'immagine dell'operatore su un'immagine di build personalizzata. Se si verificano pacchetti che non riescono durante l'installazione a causa di una dipendenza di sistema non soddisfatta, usa questa opzione.
Carica le librerie di oggetti condivisi 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 condivisi per la dipendenza PyPI (un file .so).
- Carica le librerie di oggetti condivisi 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 i 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 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.
- Installa 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 del 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, ridefinire il parametro
index-url
, come descritto. - Se il criterio di sicurezza consente l'accesso a indirizzi IP esterni dalla rete VPC, puoi abilitare l'installazione dei 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 opzione potrebbe non essere appropriata se la struttura ad albero delle dipendenze è di grandi dimensioni.
Installa in un ambiente IP privato soggetto a limitazioni relative alla località delle risorse
Mantenere il progetto conforme ai requisiti per la restrizione sulla località delle risorse impedisce l'uso di alcuni strumenti. In particolare, non è possibile utilizzare Cloud Build 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 gli 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 di Controlli di servizio VPC comporta ulteriori limitazioni di sicurezza. In particolare, non è possibile utilizzare Cloud Build 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
- Risoluzione dei problemi relativi ad aggiornamenti e upgrade