Configurare Secret Manager per il tuo ambiente

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

Questa pagina mostra come utilizzare Secret Manager per archiviare in modo sicuro le connessioni e i secret di Airflow.

Prima di iniziare

• Per utilizzare Secret Manager, l'ambiente Cloud Composer deve utilizzare Airflow 1.10.10 o versioni successive e Python 3.6 o versioni successive.
• Python 2 non è supportato.

Configurare Secret Manager per il tuo ambiente

Questa sezione spiega come configurare Secret Manager in modo da poter utilizzare i secret con l'ambiente Cloud Composer.

Abilita l'API Secret Manager

Console

Enable the Secret Manager API.

Enable the API

gcloud

Enable the Secret Manager API:

gcloud services enable secretmanager.googleapis.com

Configura il controllo dell'accesso

Devi configurare controllo dell'accesso'accesso in modo che Airflow possa accedere ai secret archiviati in Secret Manager.

A questo scopo, il account di servizio che accede ai secret deve disporre di un ruolo con l'autorizzazione secretmanager.versions.access. Ad esempio, il ruolo Funzione di accesso ai secret di Secret Manager include questa autorizzazione.

Puoi concedere questo ruolo a livello di secret, progetto, cartella o organizzazione.

Utilizza una delle seguenti opzioni:

• (Consigliato) Concedi questo ruolo all'account di servizio del tuo ambiente.

• Esegui l'override del account di servizio con cui Airflow accede a Secret Manager.

  Attenzione: questo metodo è meno consigliabile perché richiede l'archiviazione delle credenziali delaccount di serviziot in un file, il che aumenta il rischio che possano essere compromesse.
  1. Concedi questo ruolo a un account di servizio.
  2. Imposta il parametro gcp_key_path dell'opzione di configurazione di Airflow backend_kwargs in modo che punti a un file JSON con le credenziali dell'account di servizio.

Abilita la serializzazione DAG

In generale, devi utilizzare il backend di Secret Manager solo all'interno dei metodi execute() degli operatori o con i modelli Jinja. Ad esempio, puoi recuperare le variabili utilizzando var.value.example_var.

Il server web Airflow viene eseguito con un account di servizio diverso con autorizzazioni limitate, pertanto non può accedere ai secret in Secret Manager. Se il codice DAG accede ai secret durante l'elaborazione DAG (non solo dalle attività) e non è possibile modificarlo per accedere ai secret dall'interno dei metodi execute(), attiva la serializzazione DAG. Una volta fatto, il server web di Airflow prende i DAG elaborati e non ha bisogno di accedere ai secret.

Attivare e configurare il backend Secret Manager

1. Esegui l'override della seguente opzione di configurazione di Airflow:

   Sezione	Chiave	Valore
   secrets	backend	airflow.providers.google.cloud.secrets.secret_manager.CloudSecretManagerBackend

   Attenzione: non utilizzare airflow.contrib.secrets.gcp_secrets_manager.CloudSecretsManagerBackend perché questo valore non consente di visualizzare i log nell'UI di Airflow.

2. Aggiungi impostazioni facoltative eseguendo l'override della seguente opzione di configurazione di Airflow:

   Sezione	Chiave	Valore
   secrets	backend_kwargs	Vedi la descrizione che segue.

   Il valore backend_kwargs è la rappresentazione JSON dell'oggetto backend_kwargs con i seguenti campi:

   • connections_prefix: il prefisso del nome del secret da leggere per ottenere le connessioni. Il valore predefinito è airflow-connections.
   • variables_prefix: il prefisso del nome del secret da leggere per ottenere le variabili. Il valore predefinito è: airflow-variables.
   • gcp_key_path: percorso del file JSON delle credenziali Google Cloud (se non fornito, viene utilizzato il account di servizio predefinito).
   • gcp_keyfile_dict: Google Cloud dizionario JSON delle credenziali. Esclusivo con gcp_key_path.
   • sep: separatore utilizzato per concatenare connections_prefix e conn_id. Il valore predefinito è -.
   • project_id: Google Cloud ID progetto in cui sono archiviati i secret.

   Ad esempio, il valore di backend_kwargs può essere: {"project_id": "<project id>", "connections_prefix":"example-connections", "variables_prefix":"example-variables", "sep":"-"}.

   Nota: l'opzione Keyfile Secret Name (in GCP Secret Manager) nella connessione Airflow è supportata solo quando Secret Manager e Cloud Composer si trovano nello stesso progetto Google Cloud .

Aggiungere connessioni e variabili in Secret Manager

Crea i secret seguendo i passaggi descritti in Creare secret e versioni.

Variabili

• Deve utilizzare il formato [variables_prefix][sep][variable_name].
• Il valore predefinito per [variables_prefix] è airflow-variables.
• Il separatore predefinito [sep] è -.

Ad esempio, se il nome della variabile è example-var, il nome del secret è airflow-variables-example-var.

Nota: se vuoi utilizzare valori diversi per [variables_prefix], [connection_prefix] o [sep], utilizza le impostazioni facoltative come descritto più avanti nella sezione Attivare e configurare il backend di Secret Manager.

Nomi delle connessioni

• Deve utilizzare il formato [connection_prefix][sep][connection_name].
• Il valore predefinito per [connection_prefix] è airflow-connections.
• Il separatore predefinito [sep] è -.

Ad esempio, se il nome della connessione è exampleConnection, il nome del secret è airflow-connections-exampleConnection.

Valori di connessione

• Deve utilizzare la rappresentazione URI. Ad esempio, postgresql://login:secret@examplehost:9000.

• L'URI deve essere codificato come URL (codificato con una percentuale). Ad esempio, una password che contiene un carattere spazio deve essere codificata nell'URL nel seguente modo: postgresql://login:secret%20password@examplehost:9000.

Airflow ha un metodo pratico per generare URI di connessione. Un esempio di come codificare un URL complesso con extra JSON è disponibile nella documentazione di Airflow.

Utilizzare Secret Manager con Cloud Composer

Quando recupera variabili e connessioni, Cloud Composer controlla prima Secret Manager. Se la variabile o la connessione richiesta non viene trovata, Cloud Composer controlla le variabili di ambiente e il database Airflow.

Nota :per motivi di sicurezza, le variabili e le connessioni di Secret Manager non sono visibili nell'interfaccia utente di Airflow.

Leggere le variabili utilizzando i modelli Jinja

Puoi utilizzare Secret Manager per leggere le variabili con modelli Jinja per i campi dell'operatore basati su modelli (risolti al momento dell'esecuzione).

Per il secret airflow-variables-secret_filename:

file_name = '{{var.value.secret_filename}}'

Leggere le variabili utilizzando operatori e callback personalizzati

Puoi anche utilizzare Secret Manager per leggere le variabili negli operatori personalizzati o nei metodi di callback degli operatori. La lettura delle variabili dall'interno dei DAG può influire negativamente sulle prestazioni, quindi utilizza i modelli Jinja se vuoi utilizzare le variabili nei tuoi DAG.

Ad esempio, per il segreto airflow-variables-secret_filename:

from airflow.models.variable import Variable
file_name = Variable.get('secret_filename')

Lettura connessioni

A meno che tu non stia scrivendo un operatore personalizzato, raramente dovrai accedere direttamente alle connessioni. La maggior parte degli hook riceve il nome della connessione come parametro di creazione di istanze e deve recuperare automaticamente le connessioni dal backend dei secret quando vengono eseguiti i task.

La lettura diretta delle connessioni può essere utile quando scrivi il tuo hook.

Ad esempio, per la connessione airflow-connections-exampleConnection:

from airflow.hooks.base_hook import BaseHook
exampleConnection = BaseHook.get_connection('exampleConnection')

BaseHook.get_connection restituisce un oggetto Connection. È possibile ottenere la rappresentazione della stringa URI di una connessione come segue:

exampleConnectionUri = BaseHook.get_connection('exampleConnection').get_uri()

Passaggi successivi

• Esegui l'override delle opzioni di configurazione di Airflow
• Accedere all'API REST Airflow