Utilizzo del controllo dell'accesso alla UI di Airflow

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Questa pagina descrive i diversi meccanismi di controllo dell'accesso per la UI di Airflow e la UI di DAG. Puoi usare questi meccanismi, in aggiunta al controllo dell'accesso forniti da IAM, per separare gli utenti UI di Airflow e UI DAG del tuo ambiente.

Panoramica del controllo dell'accesso alla UI di Airflow in Cloud Composer

L'accesso all'interfaccia utente di Airflow e all'interfaccia utente del DAG e la visibilità dei dati e delle operazioni in queste interfacce utente sono controllati su due livelli in Cloud Composer:

  1. L'accesso all'interfaccia utente di Airflow e all'interfaccia utente di DAG in Cloud Composer è controllato da IAM.

    Se un account non ha un ruolo che visualizzare gli ambienti Cloud Composer nel tuo progetto, le UI di Airflow e DAG non sono disponibili.

    IAM non fornisce ulteriori informazioni delle autorizzazioni nella UI di Airflow o DAG.

  2. Il modello di controllo degli accessi di Apache Airflow consente di Ridurre la visibilità nelle UI di Airflow e DAG in base al ruolo utente.

    Il controllo dell'accesso di Apache Airflow è una funzionalità di Airflow, con il suo proprio modello di utenti, ruoli e autorizzazioni, diverso da IAM.

Il controllo degli accessi di Apache Airflow utilizza autorizzazioni basate sulle risorse. Tutti gli utenti di Airflow con un ruolo Airflow specifico ottengono le autorizzazioni di questo ruolo. Ad esempio, gli utenti di Airflow che dispongono di un ruolo con l'autorizzazione can delete on Connections possono eliminare le connessioni nella pagina Connessioni dell'interfaccia utente di Airflow.

Puoi anche assegnare autorizzazioni a livello di DAG per i singoli DAG. Per ad esempio, in modo che solo gli utenti con un ruolo Airflow specifico possano vedere un determinato DAG nella UI di Airflow. In Cloud Composer puoi assegnare automaticamente le autorizzazioni a livello di DAG, in base alla sottocartella in cui si trova il file DAG nel bucket dell'ambiente.

Se vuoi configurare l'accesso per le identità esterne mediante Federazione delle identità per la forza lavoro, prima concedere l'accesso all'ambiente in IAM, come descritto in Concedi ruoli IAM a identità esterne . In seguito, puoi utilizzare il controllo dell'accesso alla UI di Airflow come di consueto. Gli utenti Airflow per le identità esterne utilizzano il proprio identificatore principale anziché l'indirizzo email e hanno valori diversi inseriti in altri campi dei record utente rispetto agli Account Google.

Prima di iniziare

Gestisci i ruoli e le impostazioni di controllo dell'accesso di Airflow

Gli utenti con il ruolo Amministratore (o equivalente) possono visualizzare e modificare le impostazioni di controllo dell'accesso nell'interfaccia utente di Airflow.

Nella UI di Airflow, puoi configurare le impostazioni di controllo dell'accesso nel menu Sicurezza. Per ulteriori informazioni sul modello di controllo dell'accesso di Airflow, sulle autorizzazioni disponibili e sui ruoli predefiniti, consulta la documentazione del controllo dell'accesso all'interfaccia utente di Airflow.

Airflow gestisce il proprio elenco di utenti. Utenti con l'amministratore (o equivalente) può visualizzare l'elenco degli utenti che hanno aperto la UI di Airflow di un ambiente e sono stati registrati in Airflow. Questo elenco include anche gli utenti preregistrati manualmente da un amministratore, come descritto nella sezione seguente.

Registra gli utenti nell'interfaccia utente di Airflow

I nuovi utenti vengono registrati automaticamente quando aprono l'UI di Airflow di un per la prima volta nell'ambiente Cloud Composer.

Al momento della registrazione, agli utenti viene concesso il ruolo specificato nel [webserver]rbac_user_registration_role Opzione di configurazione Airflow. Puoi Controlla il ruolo degli utenti appena registrati eseguendo l'override di questo Opzione di configurazione Airflow con un valore diverso.

Se non specificato, il ruolo di registrazione predefinito è Op negli ambienti con Airflow 2.

Per creare una configurazione di ruoli di base per l'interfaccia utente di Airflow, consigliamo di seguire i passaggi che seguono:

  1. Gli amministratori dell'ambiente aprono la UI di Airflow per i contenuti appena creati completamente gestito di Google Cloud.

  2. Concedi agli account amministratore il ruolo Admin. Il ruolo predefinito per nuovi account in ambienti con Airflow 2 è Op. Per assegnare il ruolo Admin, esegui questo comando Comando dell'interfaccia a riga di comando di Airflow con gcloud CLI:

      gcloud composer environments run ENVIRONMENT_NAME \
    --location LOCATION \
    users add-role -- -e USER_EMAIL -r Admin

    Sostituisci:

    • ENVIRONMENT_NAME con il nome dell'ambiente.
    • LOCATION con la regione in cui si trova l'ambiente.
    • USER_EMAIL con l'indirizzo email di un account utente.

  3. Ora gli amministratori possono configurare il controllo dell'accesso per i nuovi utenti, inclusa la concessione del ruolo Admin ad altri utenti.

Preregistrare gli utenti

Gli utenti vengono registrati automaticamente con ID numerici degli account utente Google (non indirizzi email) come nomi utente. Puoi anche preregistrare manualmente un utente e assegnargli un ruolo aggiungendo un record utente con il campo del nome utente impostato sull'indirizzo email principale dell'utente. Quando un utente con un indirizzo email abbinando un record di un utente preregistrato accede per la prima volta alla UI di Airflow, il loro nome utente viene sostituito con l'ID utente attualmente (al momento al primo accesso) identificati dal loro indirizzo email. La relazione tra le identità Google (indirizzi email) e gli account utente (ID utente) non è fissa. I gruppi Google non possono essere preregistrati.

Per preregistrare gli utenti, puoi utilizzare l'interfaccia utente di Airflow o eseguire un comando dell'interfaccia a riga di comando di Airflow tramite Google Cloud CLI.

Per preregistrare un utente con un ruolo personalizzato tramite Google Cloud CLI: Esegui questo comando dell'interfaccia a riga di comando di Airflow:

gcloud composer environments run ENVIRONMENT_NAME \
  --location LOCATION \
  users create -- \
  -r ROLE \
  -e USER_EMAIL \
  -u USER_EMAIL \
  -f FIRST_NAME \
  -l LAST_NAME \
  --use-random-password # The password value is required, but is not used

Sostituisci quanto segue:

  • ENVIRONMENT_NAME: il nome dell'ambiente
  • LOCATION: la regione in cui si trova l'ambiente
  • ROLE: un ruolo Airflow per l'utente, ad esempio Op
  • USER_EMAIL: l'indirizzo email dell'utente
  • FIRST_NAME e LAST_NAME: nome e cognome dell'utente

Esempio:

gcloud composer environments run example-environment \
  --location us-central1 \
  users create -- \
  -r Op \
  -e "example-user@example.com" \
  -u "example-user@example.com" \
  -f "Name" \
  -l "Surname" \
  --use-random-password

Rimuovi utenti

L'eliminazione di un utente da Airflow non comporta la revoca del suo accesso, perché viene registrato di nuovo automaticamente alla successiva accesso all'interfaccia utente di Airflow. Per revocare l'accesso all'intera UI di Airflow, rimuovi l'autorizzazione composer.environments.get dal criterio di autorizzazione per il tuo progetto.

Puoi anche impostare il ruolo dell'utente su Pubblico, che mantiene la registrazione dell'utente, ma rimuove tutte le autorizzazioni per l'interfaccia utente di Airflow.

Configura automaticamente le autorizzazioni a livello di DAG

La funzione di registrazione dei ruoli per cartella crea automaticamente ruolo Airflow personalizzato per ogni sottocartella direttamente all'interno della cartella /dags e concede a questo ruolo l'accesso a livello di DAG a tutti I DAG i cui file di origine sono archiviati nella rispettiva sottocartella. In questo modo, la gestione dei ruoli Airflow personalizzati e il relativo accesso ai DAG vengono semplificati.

Come funziona la registrazione dei ruoli per cartella

La registrazione dei ruoli per cartella è un modo automatico per configurare i ruoli e le relative autorizzazioni a livello di DAG. Di conseguenza, può causare conflitti con altri meccanismi Airflow che concedono autorizzazioni a livello di DAG:

Per evitare questi conflitti, abilitando anche la registrazione dei ruoli per cartella cambia il comportamento di questi meccanismi.

In Airflow 2:

  • Puoi concedere l'accesso ai DAG ai ruoli tramite la proprietà access_control definita nel codice sorgente del DAG.
  • Concedere manualmente le autorizzazioni DAG (tramite l'UI di Airflow o gcloud CLI) possono causare conflitti. Ad esempio, se concedi manualmente autorizzazioni a livello di DAG a un ruolo per cartella, queste autorizzazioni possono essere rimosse o sovrascritte quando il gestore DAG sincronizza un DAG. Consigliamo di non concedere manualmente le autorizzazioni DAG.
  • I ruoli hanno un'unione di autorizzazioni di accesso al DAG registrate tramite la registrazione dei ruoli per ogni cartella e definite nella proprietà access_control del DAG.

I DAG che si trovano direttamente nella cartella di primo livello /dags non vengono assegnati automaticamente a nessun ruolo per cartella. Non sono accessibili con nessun ruolo per cartella. Altro quali Amministratore, Operatore, Utente o qualsiasi ruolo personalizzato a cui sono state concesse le autorizzazioni, per accedervi tramite la UI di Airflow e DAG.

Se carichi i DAG in sottocartelle con nomi che corrispondono ai ruoli Airflow integrati e ruoli creati da Cloud Composer, quindi le autorizzazioni per i DAG queste sottocartelle sono ancora assegnate a questi ruoli. Ad esempio, il caricamento di un DAG nella cartella /dags/Admin concede le autorizzazioni per questo DAG al ruolo Amministratore. I ruoli Airflow integrati includono Amministratore, Operatore, Utente, Visualizzatore e Pubblico. Cloud Composer crea i valori NoDags e UserNoDags dopo i valori Per-folder La funzionalità di registrazione dei ruoli è abilitata.

Airflow esegue la registrazione dei ruoli per cartella quando elabora i DAG nello scheduler di Airflow. Se il tuo ambiente contiene più di cento DAG, potresti notare un aumento del tempo di analisi del DAG. In questo caso, ti consigliamo di utilizzare più memoria e CPU per gli scheduler. Tu può anche aumentare il valore del flusso d'aria [scheduler]parsing_processes di configurazione.

Assegnare automaticamente i DAG ai ruoli per cartella

Per assegnare automaticamente i DAG ai ruoli per cartella:

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

    Sezione Chiave Valore
    webserver rbac_autoregister_per_folder_roles True

  2. Modifica il ruolo di registrazione del nuovo utente in un ruolo senza accesso ai DAG. In questo modo, i nuovi utenti non hanno accesso a nessun DAG finché un amministratore non assegna ai loro account un ruolo con autorizzazioni per DAG specifici.

    UserNoDags è un ruolo creato da Cloud Composer solo quando La funzionalità di registrazione dei ruoli per cartella è abilitata. È equivalente al ruolo Utente, ma senza accesso ai DAG.

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

    Sezione Chiave Valore
    webserver rbac_user_registration_role UserNoDags

  3. Assicurati che gli utenti siano registrati in Airflow.

  4. Assegna i ruoli agli utenti utilizzando uno dei seguenti approcci:

    • Consenti ad Airflow di creare automaticamente i ruoli in base alle sottocartelle dei DAG, poi assegna gli utenti a questi ruoli.
    • Crea in anticipo ruoli vuoti per le sottocartelle dei DAG, con i nomi dei ruoli corrispondenti il nome di una sottocartella, quindi assegna agli utenti questi ruoli. Ad esempio, per la cartella /dags/CustomFolder, crea un ruolo denominato CustomFolder.

  5. Carica i DAG in sottocartelle con nomi corrispondenti ai ruoli assegnati agli utenti. Queste sottocartelle devono trovarsi all'interno della cartella /dags in del bucket dell'ambiente. Airflow aggiunge le autorizzazioni ai DAG in un sottocartella, in modo che solo gli utenti con il ruolo corrispondente possano accedervi. tramite la UI di Airflow e di DAG.

Configura manualmente le autorizzazioni a livello di DAG

Puoi configurare autorizzazioni a livello di DAG per i ruoli personalizzati per specificare quali DAG sono visibili per gruppi di utenti specifici.

Per configurare le autorizzazioni a livello di DAG nell'interfaccia utente di Airflow:

  1. L'amministratore crea ruoli vuoti per il raggruppamento dei DAG.
  2. L'amministratore assegna gli utenti ai ruoli appropriati.
  3. L'amministratore o gli utenti assegnano i DAG ai ruoli.
  4. Nell'interfaccia utente di Airflow, gli utenti possono vedere solo i DAG assegnati al loro gruppo.

I DAG possono essere assegnati ai ruoli tramite le proprietà DAG o dall'interfaccia utente di Airflow.

Assegnazione di DAG ai ruoli nella UI di Airflow

Un amministratore può assegnare le autorizzazioni richieste a livello di DAG ai ruoli appropriati nell'interfaccia utente di Airflow.

Questa operazione non è supportata nella UI dei DAG.

Assegnare i DAG ai ruoli nelle proprietà DAG

Puoi impostare access_control parametro DAG su un DAG, specificando il ruolo o i ruoli di raggruppamento dei DAG a cui è assegnato il DAG.

Nelle versioni di Airflow 2 precedenti alla 2.1.0, l'amministratore, lo sviluppatore DAG o un processo automatico deve eseguire il sync-perm comando Airflow per applicare le nuove impostazioni di controllo dell'accesso.

In Airflow 2.1.0 e versioni successive, l'esecuzione di questo comando non è più necessaria, perché lo scheduler applica autorizzazioni a livello di DAG quando analizza un con il DAG.

dag = DAG(
  access_control={
    'DagGroup': {'can_edit', 'can_read'},
  },
  ...
  )

Mappa i log di controllo nell'interfaccia utente di Airflow agli utenti

Gli audit log nella UI di Airflow sono mappati ID numerici degli account utente Google. Per Ad esempio, se un utente mette in pausa un DAG, viene aggiunta una voce ai log.

Puoi visualizzare gli audit log nella pagina Sfoglia > Log di controllo in la UI di Airflow.

Una voce nella pagina Audit Logs in Airflow 2
Figura 1. Una voce nella pagina Audit log in Airflow 2

Una voce tipica elenca un ID numerico nel campo Proprietario: accounts.google.com:NUMERIC_ID. Puoi mappare gli ID numerici alle email degli utenti nella pagina Sicurezza > Elenca utenti. Questa pagina è disponibile per gli utenti con il ruolo Admin.

Tieni presente che la relazione tra identità Google (indirizzi email) e account utente (ID utente) non è fissa.

Passaggi successivi