Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
Questa pagina descrive come utilizzare KubernetesPodOperator per eseguire il deployment di pod Kubernetes da Cloud Composer nel cluster Google Kubernetes Engine che fa parte del tuo ambiente Cloud Composer.
Lancio di KubernetesPodOperator Pod Kubernetes nel cluster dell'ambiente. In confronto, Gli operatori di Google Kubernetes Engine eseguono i pod Kubernetes in un che può essere un cluster separato non correlato al tuo completamente gestito di Google Cloud. Puoi anche creare ed eliminare i cluster utilizzando gli operatori Google Kubernetes Engine.
KubernetesPodOperator è una buona opzione se hai bisogno di:
- Dipendenze Python personalizzate che non sono disponibili tramite la piattaforma PyPI pubblica repository Git.
- Dipendenze binarie non disponibili nell'immagine worker Cloud Composer di serie.
Prima di iniziare
Se viene utilizzata la versione 5.0.0 di CNCF Kubernetes Provider, segui le istruzioni descritte nella sezione CNCF Kubernetes Provider.
La configurazione dell'affinità dei pod non è disponibile in Cloud Composer 2. Se vuoi per utilizzare l'affinità pod, utilizza gli operatori GKE per avviare i pod in un cluster diverso.
Informazioni su KubernetesPodOperator in Cloud Composer 2
Questa sezione descrive il funzionamento di KubernetesPodOperator in Cloud Composer 2.
Utilizzo delle risorse
In Cloud Composer 2, il cluster del tuo ambiente scala automaticamente. I carichi di lavoro aggiuntivi eseguiti con KubernetesPodOperator si scalano indipendentemente dal tuo ambiente.
L'ambiente non è interessato dall'aumento della domanda di risorse, ma il cluster dell'ambiente viene scalato in base alla domanda di risorse.
I prezzi per i carichi di lavoro aggiuntivi che esegui in che il cluster dell'ambiente segue Modello di prezzi di Cloud Composer 2 e utilizzi SKU di computing di Cloud Composer.
Cloud Composer 2 utilizza i cluster Autopilot che introducono il concetto di classi di calcolo:
Cloud Composer supporta solo la classe di calcolo
general-purpose
.Per impostazione predefinita, se non è selezionata alcuna classe, viene presupposta la classe
general-purpose
quando crei i pod utilizzando KubernetesPodOperator.Ogni classe è associata a proprietà e limiti di risorse specifici, Puoi leggere informazioni in merito in Documentazione di Autopilot. Per Ad esempio, i pod in esecuzione nella classe
general-purpose
possono utilizzare fino a 110 GiB di memoria.
Accesso alle risorse del progetto
Cloud Composer 2 utilizza i cluster GKE con Workload Identity Federation for GKE. I pod in esecuzione nello spazio dei nomi composer-user-workloads
possono accedere alle risorse Google Cloud nel progetto senza dover eseguire alcuna configurazione aggiuntiva. Account di servizio del tuo ambiente
per accedere a queste risorse.
Se vuoi utilizzare un nome di spazio personalizzato, gli account di servizio Kubernetes associati a questo spazio devono essere mappati agli account di servizio Google Cloud per attivare l'autorizzazione dell'identità servizio per le richieste alle API Google e ad altri servizi. Se esegui i pod in un namespace personalizzato nel cluster del tuo ambiente, le associazioni IAM tra Kubernetes e gli account di servizio Google Cloud non vengono create e questi pod non possono accedere alle risorse del tuo progetto Google Cloud.
Se utilizzi uno spazio dei nomi personalizzato e vuoi che i pod abbiano accesso all'interno delle risorse Google Cloud, segui le indicazioni in Federazione delle identità per i carichi di lavoro per GKE e configura le associazioni per uno spazio dei nomi personalizzato:
- Crea uno spazio dei nomi separato nel cluster del tuo ambiente.
- Crea un'associazione tra l'account di servizio Kubernetes dello spazio dei nomi personalizzato e l'account di servizio del tuo ambiente.
- Aggiungi l'annotazione dell'account di servizio del tuo ambiente a Kubernetes l'account di servizio.
- Quando utilizzi KubernetesPodOperator, specifica lo spazio dei nomi
Account di servizio Kubernetes in
namespace
eservice_account_name
parametri.
Configurazione minima
Per creare un KubernetesPodOperator, sono obbligatori solo i parametri name
, image
da utilizzare e
task_id
del pod. /home/airflow/composer_kube_config
contiene le credenziali per l'autenticazione su GKE.
Configurazione aggiuntiva
Questo esempio mostra parametri aggiuntivi che puoi configurare nel KubernetesPodOperator.
Per ulteriori informazioni sui parametri, consulta la documentazione di riferimento di Airflow per KubernetesPodOperator. Per informazioni sull'utilizzo di secret e ConfigMap di Kubernetes, consulta Utilizzare secret e ConfigMap di Kubernetes. Per informazioni sull'utilizzo dei modelli Jinja con KubernetesPodOperator, vedi Usa modelli Jinja.
Utilizzare i modelli Jinja
Airflow supporta i modelli Jinja nei DAG.
Devi dichiarare i parametri Airflow richiesti (task_id
, name
e
image
) all'operatore. Come mostrato nell'esempio seguente,
puoi creare un modello per tutti gli altri parametri con Jinja, inclusi cmds
,
arguments
, env_vars
e config_file
.
Il parametro env_vars
nell'esempio viene impostato da un
Variabile Airflow denominata my_value
. Il DAG di esempio ricava il proprio valore dalla variabile del modello vars
in Airflow. Airflow offre
che forniscono l'accesso a diversi tipi di informazioni. Ad esempio,
puoi utilizzare la variabile del modello conf
per accedere ai valori delle
opzioni di configurazione di Airflow. Per ulteriori informazioni e per
delle variabili disponibili in Airflow, consulta
Riferimento ai modelli in Airflow
documentazione.
Se non modifichi il DAG o non crei la variabile env_vars
, l'attività ex-kube-templates
nell'esempio non va a buon fine perché la variabile non esiste. Crea questa variabile nella UI di Airflow o con Google Cloud CLI:
Interfaccia utente di Airflow
Vai all'interfaccia utente di Airflow.
Nella barra degli strumenti, seleziona Amministrazione > Voci.
Nella pagina List Variable (Variabile elenco), fai clic su Add a new record (Aggiungi un nuovo record).
Nella pagina Aggiungi variabile, inserisci le seguenti informazioni:
- Chiave:
my_value
- Val:
example_value
- Chiave:
Fai clic su Salva.
gcloud
Inserisci questo comando:
gcloud composer environments run ENVIRONMENT \
--location LOCATION \
variables set -- \
my_value example_value
Sostituisci:
ENVIRONMENT
con il nome dell'ambiente.LOCATION
con la regione in cui si trova l'ambiente.
L'esempio seguente mostra come utilizzare i modelli Jinja con KubernetesPodOperator:
Utilizzare secret e ConfigMap di Kubernetes
Un secret di Kubernetes è un oggetto che contiene dati sensibili. Un cluster Kubernetes ConfigMap è un oggetto che contiene dati non riservati in coppie chiave/valore.
In Cloud Composer 2, puoi creare secret e ConfigMap utilizzando Google Cloud CLI, l'API o Terraform, quindi accedervi da KubernetesPodOperator.
Informazioni sui file di configurazione YAML
Quando crei un Secret Kubernetes o un ConfigMap utilizzando Google Cloud CLI API, devi fornire un file in formato YAML. Questo file deve avere lo stesso formato utilizzato da Kubernetes Secret e ConfigMap. La documentazione di Kubernetes fornisce molti esempi di codice di ConfigMap e secret. Per iniziare, consulta la pagina Distribuzione sicura delle credenziali tramite Secret e ConfigMaps.
Come in Kubernetes Secrets, utilizza la rappresentazione base64 quando definisci i valori nei secret.
Per codificare un valore, puoi utilizzare il comando seguente (uno dei molti modi per ottenere un valore con codifica Base64):
echo "postgresql+psycopg2://root:example-password@127.0.0.1:3306/example-db" -n | base64
Output:
cG9zdGdyZXNxbCtwc3ljb3BnMjovL3Jvb3Q6ZXhhbXBsZS1wYXNzd29yZEAxMjcuMC4wLjE6MzMwNi9leGFtcGxlLWRiIC1uCg==
I due esempi di file YAML riportati di seguito vengono utilizzati negli esempi più avanti in questa guida. File di configurazione YAML di esempio per un secret di Kubernetes:
apiVersion: v1
kind: Secret
metadata:
name: airflow-secrets
data:
sql_alchemy_conn: cG9zdGdyZXNxbCtwc3ljb3BnMjovL3Jvb3Q6ZXhhbXBsZS1wYXNzd29yZEAxMjcuMC4wLjE6MzMwNi9leGFtcGxlLWRiIC1uCg==
Un altro esempio che mostra come includere i file. Come nell'esempio precedente, codifica prima i contenuti di un file (cat ./key.json | base64
), quindi fornisci questo valore nel file YAML:
apiVersion: v1
kind: Secret
metadata:
name: service-account
data:
service-account.json: |
ewogICJ0eXBl...mdzZXJ2aWNlYWNjb3VudC5jb20iCn0K
Un file di configurazione YAML di esempio per un ConfigMap. Non è necessario usare il modello base64 in ConfigMap:
apiVersion: v1
kind: ConfigMap
metadata:
name: example-configmap
data:
example_key: example_value
Gestisci i secret di Kubernetes
In Cloud Composer 2, crei i secret utilizzando Google Cloud CLI e kubectl
:
Ottieni informazioni sul cluster del tuo ambiente:
Esegui questo comando:
gcloud composer environments describe ENVIRONMENT \ --location LOCATION \ --format="value(config.gkeCluster)"
Sostituisci:
ENVIRONMENT
con il nome del tuo ambiente.LOCATION
con la regione in cui si trova l'ambiente Cloud Composer.
L'output di questo comando utilizza il seguente formato:
projects/<your-project-id>/locations/<location-of-composer-env>/clusters/<your-cluster-id>
.Per ottenere l'ID cluster GKE, copia l'output dopo
/clusters/
(termina con-gke
).
Connettiti al tuo cluster GKE con quanto segue :
gcloud container clusters get-credentials CLUSTER_ID \ --project PROJECT \ --region LOCATION
Sostituisci quanto segue:
CLUSTER_ID
: ID cluster dell'ambiente.PROJECT_ID
: l'ID del progetto.LOCATION
: la regione in cui si trova l'ambiente.
Crea i secret Kubernetes:
I seguenti comandi mostrano due approcci diversi per la creazione di segreti Kubernetes. L'approccio
--from-literal
utilizza coppie chiave/valore. L'approccio--from-file
utilizza contenuti di file.Per creare un secret di Kubernetes fornendo coppie chiave-valore, esegui il comando . In questo esempio viene creato un secret denominato
airflow-secrets
che ha un camposql_alchemy_conn
con il valoretest_value
.kubectl create secret generic airflow-secrets \ --from-literal sql_alchemy_conn=test_value -n composer-user-workloads
Per creare un secret di Kubernetes fornendo i contenuti del file, esegui . In questo esempio viene creato un secret denominato
service-account
che ha il camposervice-account.json
con preso dai contenuti di un file./key.json
locale.kubectl create secret generic service-account \ --from-file service-account.json=./key.json -n composer-user-workloads
Utilizzare i secret di Kubernetes nei DAG
Questo esempio mostra due modi per utilizzare i secret di Kubernetes: come variabile di ambiente e come volume montato dal pod.
Il primo secret, airflow-secrets
, è impostato
a una variabile di ambiente Kubernetes denominata SQL_CONN
(anziché una
la variabile di ambiente Airflow o Cloud Composer).
Il secondo secret, service-account
, monta service-account.json
, un file
con un token dell'account di servizio, a /var/secrets/google
.
Ecco come sono gli oggetti Secret:
Il nome del primo secret di Kubernetes è definito nella variabile secret_env
.
Questo secret si chiama airflow-secrets
. Il parametro deploy_type
specifica
che deve essere esposto come variabile di ambiente. Il nome della variabile di ambiente è SQL_CONN
, come specificato nel parametro deploy_target
. Infine, il valore della variabile di ambiente SQL_CONN
viene impostato sul valore della chiave sql_alchemy_conn
.
Il nome del secondo secret Kubernetes è definito nella variabile secret_volume
. Questo secret è denominato service-account
. Viene esposto come
come specificato nel parametro deploy_type
. Il percorso del file in
la montatura, deploy_target
, è /var/secrets/google
. Infine, il key
del segreto memorizzato nel deploy_target
è service-account.json
.
Ecco come si presenta la configurazione dell'operatore:
Informazioni sul fornitore Kubernetes CNCF
KubernetesPodOperator è implementato
Provider apache-airflow-providers-cncf-kubernetes
.
Per note di rilascio dettagliate per il provider Kubernetes CNCF, consulta Sito web del provider Kubernetes del CNC.
Versione 6.0.0
Nella versione 6.0.0 del pacchetto del provider Kubernetes CNCF,
la connessione kubernetes_default
viene utilizzata per impostazione predefinita in KubernetesPodOperator.
Se hai specificato una connessione personalizzata nella versione 5.0.0,
è ancora utilizzato dall'operatore. Per tornare a utilizzare kubernetes_default
potresti voler regolare i DAG di conseguenza.
Versione 5.0.0
Questa versione introduce alcune modifiche non compatibili con le versioni precedenti
rispetto alla versione 4.4.0. I più importanti sono correlati
la connessione kubernetes_default
non utilizzata nella versione 5.0.0.
- La connessione
kubernetes_default
deve essere modificata. Configurazione Kubernetes il percorso deve essere impostato su/home/airflow/composer_kube_config
(come illustrato nella figura che segue). In alternativa,config_file
deve essere aggiunto alla configurazione di KubernetesPodOperator (come mostrato nell'esempio di codice seguente).
- Modifica il codice di un'attività utilizzando KubernetesPodOperator nel seguente modo:
KubernetesPodOperator(
# config_file parameter - can be skipped if connection contains this setting
config_file="/home/airflow/composer_kube_config",
# definition of connection to be used by the operator
kubernetes_conn_id='kubernetes_default',
...
)
Per ulteriori informazioni sulla versione 5.0.0, consulta le note di rilascio del provider Kubernetes CNCF.
Risoluzione dei problemi
Questa sezione fornisce consigli per la risoluzione dei problemi comuni di KubernetesPodOperator:
Visualizza i log
Durante la risoluzione dei problemi, puoi controllare i log nel seguente ordine:
Log delle attività Airflow:
Nella console Google Cloud, vai alla pagina Ambienti.
Nell'elenco degli ambienti, fai clic sul nome del tuo ambiente. Viene visualizzata la pagina Dettagli dell'ambiente.
Vai alla scheda DAG.
Fai clic sul nome del DAG e poi sull'esecuzione del DAG per visualizzare i dettagli e log.
Log dello scheduler Airflow:
Vai alla pagina Dettagli dell'ambiente.
Vai alla scheda Log.
Controlla i log dello scheduler di Airflow.
Log dei pod nella console Google Cloud, nella sezione Carichi di lavoro GKE. Questi log includono il file YAML di definizione del pod, gli eventi del pod e i dettagli del pod.
Codici di ritorno diversi da zero
Quando utilizzi KubernetesPodOperator (e GKEStartPodOperator), il parametro del punto di ingresso del container determina se l'attività possono avere successo o meno. I codici di ritorno diversi da zero indicano un errore.
Un pattern comune è eseguire uno script shell come punto di ingresso del container raggruppare più operazioni all'interno del container.
Se stai scrivendo uno script di questo tipo, ti consigliamo di includere il comando set -e
nella parte superiore dello script in modo che i comandi non riusciti nello script interrompano lo script e propaghino l'errore all'istanza dell'attività Airflow.
Timeout dei pod
Il timeout predefinito per KubernetesPodOperator è 120 secondi, il che può comportare timeout prima del download di immagini di dimensioni maggiori. Puoi
aumentare il timeout modificando il parametro startup_timeout_seconds
quando
crei KubernetesPodOperator.
Quando un pod scade, il log specifico dell'attività è disponibile nell'interfaccia utente di Airflow. Ad esempio:
Executing <Task(KubernetesPodOperator): ex-all-configs> on 2018-07-23 19:06:58.133811
Running: ['bash', '-c', u'airflow run kubernetes-pod-example ex-all-configs 2018-07-23T19:06:58.133811 --job_id 726 --raw -sd DAGS_FOLDER/kubernetes_pod_operator_sample.py']
Event: pod-name-9a8e9d06 had an event of type Pending
...
...
Event: pod-name-9a8e9d06 had an event of type Pending
Traceback (most recent call last):
File "/usr/local/bin/airflow", line 27, in <module>
args.func(args)
File "/usr/local/lib/python2.7/site-packages/airflow/bin/cli.py", line 392, in run
pool=args.pool,
File "/usr/local/lib/python2.7/site-packages/airflow/utils/db.py", line 50, in wrapper
result = func(*args, **kwargs)
File "/usr/local/lib/python2.7/site-packages/airflow/models.py", line 1492, in _run_raw_task
result = task_copy.execute(context=context)
File "/usr/local/lib/python2.7/site-packages/airflow/contrib/operators/kubernetes_pod_operator.py", line 123, in execute
raise AirflowException('Pod Launching failed: {error}'.format(error=ex))
airflow.exceptions.AirflowException: Pod Launching failed: Pod took too long to start
I timeout dei pod possono verificarsi anche Account di servizio Cloud Composer non disponga delle autorizzazioni IAM necessarie per eseguire l'attività mano. Per verificare, controlla gli errori a livello di pod utilizzando le dashboard GKE per esaminare i log relativi al tuo determinato carico di lavoro oppure utilizza Cloud Logging.
Impossibile stabilire una nuova connessione
L'upgrade automatico è abilitato per impostazione predefinita nei cluster GKE. Se un pool di nodi si trova in un cluster in fase di upgrade, potresti vedere quanto segue errore:
<Task(KubernetesPodOperator): gke-upgrade> Failed to establish a new
connection: [Errno 111] Connection refused
Per verificare se è in corso l'upgrade del cluster, nella console Google Cloud vai alla Cluster Kubernetes e cerca l'icona di caricamento accanto al tuo il nome del cluster dell'ambiente.