Utiliser le contrôle des accès à l'interface utilisateur d'Airflow

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Cette page décrit différents mécanismes de contrôle des accès pour les interfaces utilisateur Airflow et DAG. Vous pouvez utiliser ces mécanismes, en plus du contrôle des accès fourni par IAM, pour séparer les utilisateurs dans les interfaces utilisateur Airflow et DAG de votre environnement.

Présentation du contrôle des accès à l'interface utilisateur d'Airflow dans Cloud Composer

L'accès à l'interface utilisateur Airflow et à l'interface utilisateur du DAG, ainsi que la visibilité des données et des opérations dans ces interfaces utilisateur, est contrôlé à deux niveaux dans Cloud Composer:

  1. L'accès à l'interface utilisateur d'Airflow et de DAG dans Cloud Composer est contrôlé par IAM.

    Si un compte ne dispose pas d'un rôle permettant d'afficher les environnements Cloud Composer dans votre projet, les interfaces utilisateur d'Airflow et de DAG ne sont pas disponibles.

    IAM ne fournit aucun contrôle d'autorisation précis supplémentaire dans l'interface utilisateur d'Airflow ou de DAG.

  2. Le modèle de contrôle des accès Apache Airflow permet de réduire la visibilité dans les interfaces utilisateur Airflow et DAG en fonction du rôle utilisateur.

    Le contrôle des accès Apache Airflow est une fonctionnalité d'Airflow, avec son propre modèle d'utilisateurs, de rôles et d'autorisations, qui est différent d'IAM.

Le contrôle des accès Apache Airflow utilise des autorisations basées sur les ressources. Tous les utilisateurs Airflow disposant d'un rôle Airflow spécifique obtiennent les autorisations associées à ce rôle. Par exemple, les utilisateurs Airflow disposant d'un rôle doté de l'autorisation can delete on Connections peuvent supprimer des connexions sur la page "Connexions" de l'interface utilisateur Airflow.

Vous pouvez également attribuer des autorisations au niveau du DAG pour les DAG individuels. Par exemple, afin que seuls les utilisateurs disposant d'un rôle Airflow spécifique puissent voir un DAG donné dans l'interface utilisateur d'Airflow. Dans Cloud Composer, vous pouvez attribuer automatiquement des autorisations au niveau du DAG, en fonction du sous-dossier contenant le fichier DAG dans le bucket de l'environnement.

Si vous souhaitez configurer l'accès des identités externes via la fédération des identités des employés, accordez d'abord l'accès à votre environnement dans IAM, comme décrit dans la section Attribuer des rôles IAM à des identités externes. Vous pouvez ensuite utiliser le contrôle des accès à l'interface utilisateur d'Airflow comme d'habitude. Les utilisateurs Airflow pour les identités externes se servent de leur identifiant principal au lieu de leur adresse e-mail, et ont des valeurs différentes de celles des comptes Google renseignées dans les autres champs d'enregistrement utilisateur.

Avant de commencer

Gérer les rôles Airflow et les paramètres de contrôle des accès

Les utilisateurs disposant du rôle Administrateur (ou équivalent) peuvent afficher et modifier les paramètres de contrôle des accès dans l'interface utilisateur d'Airflow.

Dans l'interface utilisateur d'Airflow, vous pouvez configurer les paramètres de contrôle des accès à partir du menu Sécurité. Pour en savoir plus sur le modèle de contrôle des accès Airflow, les autorisations disponibles et les rôles par défaut, consultez la documentation sur le contrôle des accès à l'interface utilisateur Airflow.

Airflow gère sa propre liste d'utilisateurs. Les utilisateurs dotés du rôle Administrateur (ou équivalent) peuvent afficher la liste des utilisateurs qui ont ouvert l'interface utilisateur Airflow d'un environnement et qui ont été enregistrés dans Airflow. Cette liste inclut également les utilisateurs préinscrits manuellement par un administrateur, comme décrit dans la section suivante.

Enregistrer des utilisateurs dans l'interface utilisateur d'Airflow

Les nouveaux utilisateurs sont automatiquement enregistrés lorsqu'ils ouvrent l'interface utilisateur Airflow d'un environnement Cloud Composer pour la première fois.

Lors de l'inscription, les utilisateurs se voient attribuer le rôle spécifié dans l'option de configuration Airflow [webserver]rbac_user_registration_role. Vous pouvez contrôler le rôle des utilisateurs nouvellement enregistrés en remplaçant cette option de configuration Airflow par une valeur différente.

S'il n'est pas spécifié, le rôle d'enregistrement par défaut est Op dans les environnements avec Airflow 2.

Les étapes suivantes sont recommandées pour créer une configuration de rôle de base pour l'interface utilisateur d'Airflow:

  1. Les administrateurs de l'environnement ouvrent l'interface utilisateur Airflow pour le nouvel environnement.

  2. Attribuer le rôle Admin aux comptes administrateur. Le rôle par défaut pour les nouveaux comptes dans les environnements avec Airflow 2 est Op. Pour attribuer le rôle Admin, exécutez la commande CLI Airflow suivante avec gcloud:

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

    Remplacez :

    • ENVIRONMENT_NAME par le nom de l'environnement.
    • LOCATION par la région dans laquelle se trouve l'environnement.
    • USER_EMAIL par l'adresse e-mail d'un compte utilisateur.

  3. Les administrateurs peuvent désormais configurer le contrôle des accès pour les nouveaux utilisateurs, ce qui inclut l'attribution du rôle Admin à d'autres utilisateurs.

Préenregistrer les utilisateurs

Les utilisateurs sont automatiquement enregistrés avec des ID numériques de comptes utilisateur Google (et non des adresses e-mail) en tant que noms d'utilisateur. Vous pouvez également préinscrire manuellement un utilisateur et lui attribuer un rôle en ajoutant un enregistrement utilisateur avec le champ "username" défini sur l'adresse e-mail principale de l'utilisateur. Lorsqu'un utilisateur dont l'adresse e-mail correspond à un enregistrement d'utilisateur préinscrit se connecte à l'interface utilisateur Airflow pour la première fois, son nom d'utilisateur est remplacé par l'ID utilisateur (au moment de la première connexion) identifié par son adresse e-mail. La relation entre les identités Google (adresses e-mail) et les comptes utilisateur (ID utilisateur) n'est pas fixe. Les groupes Google ne peuvent pas être préenregistrés.

Pour préinscrire des utilisateurs, vous pouvez utiliser l'interface utilisateur d'Airflow ou exécuter une commande de CLI Airflow via la Google Cloud CLI.

Pour préenregistrer un utilisateur avec un rôle personnalisé via la Google Cloud CLI, exécutez la commande CLI Airflow suivante:

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

Remplacez les éléments suivants :

  • ENVIRONMENT_NAME: nom de l'environnement
  • LOCATION: région où se trouve l'environnement
  • ROLE: rôle Airflow pour l'utilisateur (par exemple, Op)
  • USER_EMAIL: adresse e-mail de l'utilisateur
  • FIRST_NAME et LAST_NAME: prénom et nom de l'utilisateur

Exemple :

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

Supprimer des comptes utilisateur

La suppression d'un utilisateur d'Airflow ne révoque pas son accès, car il est automatiquement réenregistré la prochaine fois qu'il accède à l'interface utilisateur d'Airflow. Pour révoquer l'accès à l'intégralité de l'interface utilisateur d'Airflow, supprimez l'autorisation composer.environments.get de la règle d'autorisation associée pour votre projet.

Vous pouvez également définir le rôle de l'utilisateur sur "Public", ce qui permet de conserver son inscription, mais de supprimer toutes les autorisations pour l'interface utilisateur d'Airflow.

Configurer automatiquement les autorisations au niveau du DAG

La fonctionnalité d'enregistrement des rôles par dossier crée automatiquement un rôle Airflow personnalisé pour chaque sous-dossier directement dans le dossier /dags et accorde à ce rôle un accès au niveau du DAG à tous les DAG dont le fichier source est stocké dans le sous-dossier correspondant. Cela simplifie la gestion des rôles Airflow personnalisés et leur accès aux DAG.

Fonctionnement de l'enregistrement des rôles par dossier

L'enregistrement de rôles par dossier est un moyen automatisé de configurer les rôles et leurs autorisations au niveau du DAG. Par conséquent, il peut entraîner des conflits avec d'autres mécanismes Airflow qui accordent des autorisations au niveau du DAG:

Pour éviter de tels conflits, l'activation de l'enregistrement des rôles par dossier modifie également le comportement de ces mécanismes.

Dans Airflow 2:

  • Vous pouvez accorder au DAG l'accès aux rôles via la propriété access_control définie dans le code source du DAG.
  • L'attribution manuelle d'autorisations DAG (via l'interface utilisateur Airflow ou gcloud CLI) peut entraîner des conflits. Par exemple, si vous accordez manuellement des autorisations au niveau du DAG à un rôle par dossier, ces autorisations peuvent être supprimées ou remplacées lorsque le processeur DAG synchronise un DAG. Nous vous recommandons de ne pas accorder manuellement les autorisations liées aux DAG.
  • Les rôles associent les autorisations d'accès au DAG enregistrées via l'enregistrement des rôles par dossier et définies dans la propriété access_control du DAG.

Les DAG situés directement dans le dossier /dags de premier niveau ne sont pas automatiquement attribués à un rôle par dossier. Ils ne sont accessibles qu'avec un rôle par dossier. Les autres rôles tels que Administrateur, Opération, Utilisateur ou tout rôle personnalisé disposant d'autorisations peuvent y accéder via l'UI Airflow et l'UI du DAG.

Si vous importez des DAG dans des sous-dossiers dont les noms correspondent aux rôles Airflow intégrés et aux rôles créés par Cloud Composer, les autorisations liées aux DAG de ces sous-dossiers sont toujours attribuées à ces rôles. Par exemple, l'importation d'un DAG dans le dossier /dags/Admin accorde des autorisations à ce DAG au rôle d'administrateur. Les rôles Airflow intégrés incluent les rôles Administrateur, Opération, Utilisateur, Lecteur et Public. Cloud Composer crée les NoDags et UserNoDags une fois que la fonctionnalité d'enregistrement des rôles par dossier est activée.

Airflow effectue l'enregistrement des rôles par dossier lors du traitement des DAG dans le programmeur Airflow. Si votre environnement compte plus d'une centaine de DAG, vous constaterez peut-être une augmentation de la durée d'analyse des DAG. Dans ce cas, nous vous recommandons d'utiliser plus de mémoire et de processeurs pour les programmeurs. Vous pouvez également augmenter la valeur de l'option de configuration Airflow [scheduler]parsing_processes.

Attribuer automatiquement des DAG aux rôles par dossier

Pour attribuer automatiquement des DAG à des rôles par dossier:

  1. Remplacez l'option de configuration Airflow suivante:

    Section Clé Valeur
    webserver rbac_autoregister_per_folder_roles True

  2. Remplacez le rôle d'enregistrement de l'utilisateur par un rôle sans accès aux DAG. Ainsi, les nouveaux utilisateurs n'ont accès à aucun DAG tant qu'un administrateur n'a pas attribué à leur compte un rôle disposant d'autorisations pour des DAG spécifiques.

    UserNoDags est un rôle créé par Cloud Composer uniquement lorsque la fonctionnalité d'enregistrement de rôles par dossier est activée. C'est l'équivalent du rôle "Utilisateur", mais n'a accès à aucun DAG.

    Remplacez l'option de configuration Airflow suivante:

    Section Clé Valeur
    webserver rbac_user_registration_role UserNoDags

  3. Assurez-vous que les utilisateurs sont enregistrés dans Airflow.

  4. Attribuez des rôles aux utilisateurs à l'aide de l'une des approches suivantes:

    • Laissez Airflow créer automatiquement des rôles basés sur les sous-dossiers des DAG, puis attribuez ces rôles aux utilisateurs.
    • Créez à l'avance des rôles vides pour les sous-dossiers des DAG, avec des noms de rôles correspondant au nom d'un sous-dossier, puis attribuez ces rôles aux utilisateurs. Par exemple, pour le dossier /dags/CustomFolder, créez un rôle nommé CustomFolder.

  5. Importez des DAG dans des sous-dossiers dont les noms correspondent aux rôles attribués aux utilisateurs. Ces sous-dossiers doivent se trouver dans le dossier /dags du bucket de l'environnement. Airflow ajoute des autorisations aux DAG d'un tel sous-dossier, afin que seuls les utilisateurs disposant du rôle correspondant puissent y accéder via les interfaces utilisateur Airflow et DAG.

Configurer manuellement les autorisations au niveau du DAG

Vous pouvez configurer des autorisations au niveau du DAG pour les rôles personnalisés afin de spécifier les DAG visibles pour des groupes d'utilisateurs spécifiques.

Pour configurer les autorisations au niveau du DAG dans l'interface utilisateur d'Airflow:

  1. L'administrateur crée des rôles vides pour regrouper les DAG.
  2. L'administrateur attribue les utilisateurs aux rôles appropriés.
  3. L'administrateur ou les utilisateurs attribuent les DAG aux rôles.
  4. Dans l'interface utilisateur d'Airflow, les utilisateurs ne peuvent voir que les DAG attribués à leur groupe.

Les DAG peuvent être attribués à des rôles via les propriétés du DAG ou depuis l'interface utilisateur Airflow.

Attribuer des DAG à des rôles dans l'interface utilisateur d'Airflow

Un administrateur peut attribuer les autorisations au niveau du DAG requises aux rôles appropriés dans l'interface utilisateur d'Airflow.

Cette opération n'est pas possible dans l'interface utilisateur du DAG.

Attribuer des DAG aux rôles en utilisant les propriétés de DAG

Vous pouvez définir le paramètre DAG access_control sur un DAG, en spécifiant le ou les rôles de regroupement des DAG auxquels le DAG est attribué.

Dans les versions Airflow 2 antérieures à la version 2.1.0, l'administrateur, le développeur DAG ou un processus automatisé doit exécuter la commande Airflow sync-perm pour appliquer les nouveaux paramètres de contrôle des accès.

Dans Airflow 2.1.0 et versions ultérieures, il n'est plus nécessaire d'exécuter cette commande, car le programmeur applique des autorisations au niveau du DAG lorsqu'il analyse un DAG.

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

Mapper les journaux d'audit dans l'interface utilisateur d'Airflow avec les utilisateurs

Dans l'interface utilisateur d'Airflow, les journaux d'audit sont mappés avec des ID numériques de comptes utilisateur Google. Par exemple, si un utilisateur met en pause un DAG, une entrée est ajoutée aux journaux.

Vous pouvez afficher les journaux d'audit sur la page Parcourir > Journaux d'audit de l'interface utilisateur Airflow.

Une entrée sur la page "Journaux d'audit" dans Airflow 2
Figure 1. Une entrée sur la page "Journaux d'audit" dans Airflow 2

Une entrée type indique un ID numérique dans le champ Owner (Propriétaire) : accounts.google.com:NUMERIC_ID. Vous pouvez mapper des ID numériques avec les adresses e-mail des utilisateurs sur la page Sécurité > Répertorier les utilisateurs. Cette page est disponible pour les utilisateurs disposant du rôle Admin.

Notez que la relation entre les identités Google (adresses e-mail) et les comptes utilisateur (ID utilisateur) n'est pas fixe.

Étapes suivantes