Usa el control de acceso de la IU de Airflow

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

En esta página, se describen los diferentes mecanismos de control de acceso para la IU de Airflow y la IU del DAG. Puedes usar estos mecanismos, además del control de acceso que proporciona IAM, para separar a los usuarios en la IU de Airflow y la IU del DAG de tu entorno.

Descripción general del control de acceso a la IU de Airflow en Cloud Composer

El acceso a la IU de Airflow y a la IU de DAG, así como la visibilidad de los datos y las operaciones en esas IU, se controlan en dos niveles en Cloud Composer:

  1. El acceso a la IU de Airflow y a la IU del DAG en Cloud Composer está controlado por IAM.

    Si una cuenta no tiene un rol que pueda ver entornos de Cloud Composer en tu proyecto, la IU de Airflow y la IU del DAG no estarán disponibles.

    IAM no proporciona ningún control de permisos detallado adicional en la IU de Airflow ni en la IU del DAG.

  2. El modelo de control de acceso de Apache Airflow permite reducir la visibilidad en la IU de Airflow y la IU del DAG según el rol del usuario.

    El control de acceso de Apache Airflow es una función de Airflow, que cuenta con su propio modelo de usuarios, roles y permisos, distinto de IAM.

El control de acceso de Apache Airflow usa permisos basados en recursos. Todos los usuarios de Airflow con un rol específico de Airflow obtienen los permisos de ese rol. Por ejemplo, los usuarios de Airflow que tienen un rol con el permiso can delete on Connections pueden borrar conexiones en la página Connections de la IU de Airflow.

También puedes asignar permisos a nivel del DAG para DAG individuales. Por ejemplo, para que solo los usuarios con un rol específico de Airflow puedan ver un DAG determinado en la IU de Airflow. En Cloud Composer, puedes asignar automáticamente permisos a nivel del DAG según la subcarpeta en la que se encuentra el archivo del DAG en el bucket del entorno.

Antes de comenzar

  • La IU de Airflow con control de acceso está disponible para las versiones de Cloud Composer 1.13.4 o posteriores y las versiones 1.10.10 o posteriores de Airflow. El entorno también debe ejecutar Python 3.

  • El registro de roles por carpeta está disponible en Cloud Composer 1.18.12 y versiones posteriores en Airflow 2, y en Cloud Composer 1.13.4 y versiones posteriores en Airflow 1.

Habilita el control de acceso a la IU de Airflow

Airflow 2

La IU de Airflow con control de acceso siempre está habilitada en Airflow 2.

Airflow 1

Para habilitar la IU de Airflow con control de acceso, anula la siguiente opción de configuración de Airflow:

Sección Clave Valor
webserver rbac True

Puedes hacerlo para un entorno existente o cuando creas un entorno nuevo.

Con esta configuración, tu entorno ejecuta la IU de Airflow con control de acceso en lugar de la IU clásica de Airflow.

Administra la configuración de control de acceso y los roles de Airflow

Los usuarios con el rol de administrador (o equivalente) pueden ver y modificar la configuración del control de acceso en la IU de Airflow.

En la IU de Airflow, puedes configurar los parámetros de configuración del control de acceso desde el menú Seguridad. Para obtener más información sobre el modelo de control de acceso de Airflow, los permisos disponibles y los roles predeterminados, consulta la documentación sobre el control de acceso de la IU de Airflow.

Airflow 1 trata el rol de usuario como una plantilla para todos los roles personalizados. Airflow copia de forma continua los permisos del rol de usuario a todos los roles personalizados, excepto los permisos de all_dags.

Airflow mantiene su propia lista de usuarios. Los usuarios con el rol de administrador (o equivalente) pueden ver la lista de usuarios que abrieron la IU de Airflow de un entorno y se registraron en Airflow. Esta lista también incluye a los usuarios que un administrador preregistró manualmente, como se describe en la siguiente sección.

Registra usuarios en la IU de Airflow

Los usuarios nuevos se registran automáticamente cuando abren la IU de Airflow de un entorno de Cloud Composer por primera vez.

Durante el registro, se otorga a los usuarios el rol especificado en la opción de configuración de Airflow [webserver]rbac_user_registration_role. Puedes controlar el rol de los usuarios registrados recientemente si anulas esta opción de configuración de Airflow con un valor diferente.

Si no se especifica, la función de registro predeterminada es Op en entornos con Airflow 2.

En entornos con Airflow 1.10.*, la función de registro predeterminada es Admin.

Se recomiendan los siguientes pasos para crear una configuración de rol básico para la IU de Airflow:

Airflow 2

  1. Los administradores del entorno abren la IU de Airflow para el entorno recién creado.

  2. Otorga a las cuentas de administrador la función Admin. La función predeterminada para las cuentas nuevas en entornos con Airflow 2 es Op. Para asignar el rol Admin, ejecuta el siguiente comando de la CLI de Airflow con gcloud CLI:

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

    Reemplaza lo siguiente:

    • ENVIRONMENT_NAME por el nombre del entorno.
    • LOCATION por la región en la que se encuentra el entorno.
    • USER_EMAIL por el correo electrónico de una cuenta de usuario.

  3. Los administradores ahora pueden configurar el control de acceso para usuarios nuevos, incluida la asignación de la función Admin a otros usuarios.

Airflow 1

  1. Los administradores del entorno abren la IU de Airflow para el entorno recién creado, en el que se registran automáticamente con el rol Admin.

  2. Anula la siguiente opción de configuración de Airflow para la función requerida para los usuarios nuevos. Por ejemplo, a User.

    Sección Clave Valor
    webserver rbac_user_registration_role User o algún otro rol que no sea de administrador

  3. Los administradores ahora pueden configurar el control de acceso a la IU de Airflow para usuarios nuevos, incluida la asignación del rol Admin a otros usuarios.

Usuarios con registro previo

Los usuarios se registran automáticamente con IDs numéricos de las cuentas de usuario de Google (no direcciones de correo electrónico) como sus nombres de usuario. También puedes registrar previamente a un usuario de forma manual y asignarle un rol si agregas un registro de usuario con el campo de nombre de usuario configurado en la dirección de correo electrónico principal del usuario. Cuando un usuario con una dirección de correo electrónico que coincide con un registro de usuario registrado previamente accede a la IU de Airflow por primera vez, su nombre de usuario se reemplaza por el ID del usuario (en el momento del primer acceso) que identifica su dirección de correo electrónico. La relación entre las identidades de Google (direcciones de correo electrónico) y las cuentas de usuario (IDs de usuario) no es fija. Los Grupos de Google no se pueden registrar previamente.

Para realizar el registro previo de los usuarios, puedes usar la IU de Airflow o ejecutar un comando de la CLI de Airflow a través de Google Cloud CLI.

Para registrar previamente a un usuario con un rol personalizado a través de Google Cloud CLI, ejecuta el siguiente comando de la CLI de 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

Reemplaza lo siguiente:

  • ENVIRONMENT_NAME: Es el nombre del entorno.
  • LOCATION: Es la región en la que se encuentra el entorno.
  • ROLE: Es un rol de Airflow para el usuario, por ejemplo, Op.
  • USER_EMAIL: La dirección de correo electrónico del usuario
  • FIRST_NAME y LAST_NAME: Nombre y apellido del usuario

Ejemplo:

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

Quitar usuarios

Borrar un usuario de Airflow no revoca el acceso para ese usuario, ya que se vuelve a registrar de forma automática la próxima vez que acceda a la IU de Airflow. Para revocar el acceso a toda la IU de Airflow, quita el permiso composer.environments.get de su política de permisos para tu proyecto.

También puedes cambiar el rol del usuario a Público, lo que mantiene el registro del usuario, pero quita todos los permisos de la IU de Airflow.

Configura automáticamente los permisos a nivel del DAG

La función de registro de roles por carpeta crea automáticamente un rol personalizado de Airflow para cada subcarpeta directamente dentro de la carpeta /dags y otorga a este rol acceso a nivel del DAG a todos los DAGs que tienen su archivo fuente almacenado en esa subcarpeta respectiva. Esto optimiza la administración de los roles personalizados de Airflow y su acceso a los DAG.

Cómo funciona el registro de roles por carpeta

El registro de roles por carpeta es una forma automatizada de configurar roles y sus permisos a nivel del DAG. Por lo tanto, puede causar conflictos con otros mecanismos de Airflow que otorgan permisos a nivel del DAG:

Para evitar estos conflictos, habilitar el registro de roles por carpeta también cambia el comportamiento de estos mecanismos.

En Airflow 1, la posibilidad de usar estos mecanismos se inhabilita cuando se habilita el registro de roles por carpeta. Toda la administración de permisos a nivel del DAG se realiza solo a través del registro de roles por carpeta.

En Airflow 2:

  • Puedes otorgar acceso a DAG a roles a través de la propiedad access_control definida en el código fuente del DAG.
  • Otorgar permisos de DAG de forma manual (a través de la IU de Airflow o gcloud CLI) puede causar conflictos. Por ejemplo, si otorgas permisos a nivel del DAG de forma manual a un rol por carpeta, estos permisos se pueden quitar o reemplazar cuando el procesador de DAG sincroniza un DAG. No recomendamos otorgar permisos de DAG de forma manual.
  • Los roles tienen una unión de permisos de acceso al DAG registrados a través del registro de roles por carpeta y definidos en la propiedad access_control del DAG.

Los DAGs ubicados directamente en la carpeta /dags de nivel superior no se asignan automáticamente a ningún rol por carpeta. No se puede acceder a ellos con ningún rol por carpeta. Otros roles, como Admin, Op, User o cualquier rol personalizado al que se le otorguen permisos, pueden acceder a ellos a través de la IU de Airflow y la IU del DAG.

Si subes DAGs a subcarpetas con nombres que coinciden con los roles integrados de Airflow y los roles creados por Cloud Composer, los permisos para los DAGs en estas subcarpetas se seguirán asignando a estos roles. Por ejemplo, subir un DAG a la carpeta /dags/Admin otorga permisos a este DAG para el rol de administrador. Los roles integrados de Airflow incluyen los de administrador, operador, usuario, visualizador y público. Cloud Composer crea NoDags y UserNoDags después de que se habilita la función de registro de roles por carpeta.

Airflow realiza el registro de roles por carpeta cuando procesa los DAG en el programador de Airflow. Si hay más de cien DAGs en tu entorno, es posible que observes un aumento en el tiempo de análisis de los DAGs. Si este es el caso, te recomendamos que aumentes el parámetro [scheduler]max_threads para un entorno de Airflow 1 o [scheduler]parsing_processes para Airflow 2.

Asigna automáticamente DAGs a roles por carpeta

Para asignar automáticamente DAG a roles por carpeta, haz lo siguiente:

  1. Anula la siguiente opción de configuración de Airflow:

    Sección Clave Valor
    webserver rbac_autoregister_per_folder_roles True

  2. Cambia el rol de registro de usuario nuevo a un rol sin acceso a ningún DAG. De esta manera, los usuarios nuevos no tienen acceso a ningún DAG hasta que un administrador les asigne un rol que tenga permisos para DAGs específicos en sus cuentas.

    UserNoDags y NoDags son roles que crea Cloud Composer solo cuando se habilita la función de registro de roles por carpeta. Son equivalentes al rol de usuario, pero sin acceso a ningún DAG. El rol UserNoDags se crea en Airflow 2, y el rol NoDags se crea en Airflow 1.

    En Airflow 2, anula la siguiente opción de configuración de Airflow:

    Sección Clave Valor
    webserver rbac_user_registration_role UserNoDags

    En Airflow 1, anula la siguiente opción de configuración de Airflow:

    Sección Clave Valor
    webserver rbac_user_registration_role NoDags

  3. Asegúrate de que los usuarios estén registrados en Airflow.

  4. Asigna roles a los usuarios con uno de los siguientes enfoques:

    • Permite que Airflow cree automáticamente roles basados en las subcarpetas de los DAG y, luego, asigna usuarios a esos roles.
    • Crea previamente roles vacíos para las subcarpetas de los DAG, con nombres de roles que coincidan con el nombre de una subcarpeta y, luego, asigna usuarios a estos roles. Por ejemplo, para la carpeta /dags/CustomFolder, crea un rol llamado CustomFolder.

  5. Sube los DAG a subcarpetas con nombres que coincidan con los roles asignados a los usuarios. Estas subcarpetas deben estar ubicadas dentro de la carpeta /dags en el bucket del entorno. Airflow agrega permisos a los DAGs en esa subcarpeta, de modo que solo los usuarios con el rol correspondiente puedan acceder a ellos a través de la IU de Airflow y la IU del DAG.

Configura los permisos a nivel del DAG de forma manual

Puedes configurar los permisos a nivel del DAG para las funciones personalizadas a fin de especificar qué DAG son visibles para grupos de usuarios específicos.

Para configurar los permisos a nivel del DAG en la IU de Airflow, haz lo siguiente:

  1. El administrador crea roles vacíos para agrupar los DAG.
  2. El administrador asigna usuarios a los roles adecuados.
  3. El administrador o los usuarios asignan DAG a los roles.
  4. En la IU de Airflow, los usuarios solo pueden ver los DAGs asignados a su grupo.

Los DAG se pueden asignar a roles a través de las propiedades de DAG o desde la IU de Airflow.

Asigna DAG a roles en la IU de Airflow

Un administrador puede asignar los permisos de nivel de DAG requeridos a los roles adecuados en la IU de Airflow.

Esta operación no se admite en la IU del DAG.

Asigna DAG a funciones en propiedades de DAG

Puedes configurar el parámetro de DAG access_control en un DAG y especificar las funciones de agrupación de DAG a las que se asigna el DAG.

Airflow 2 

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

Airflow 1 

dag = DAG(
  access_control={
    'DagGroup': {'can_dag_edit', 'can_dag_read'},
  },
  ...
  )

Cómo asignar registros de auditoría en la IU de Airflow a los usuarios

Los registros de auditoría en la IU de Airflow se asignan a IDs numéricos de las cuentas de usuario de Google. Por ejemplo, si un usuario detiene un DAG, se agrega una entrada a los registros.

Airflow 2

En Airflow 2, puedes ver los registros de auditoría en la página Browse > Audit Logs de la IU de Airflow.

Una entrada en la página Registros de auditoría en Airflow 2
Figura 1. Una entrada en la página Registros de auditoría en Airflow 2

Airflow 1

En Airflow 1, puedes ver los registros de auditoría en la página Browse > Logs.

Una entrada en la página Registros en Airflow 1
Figura 1. Una entrada en la página Registros en Airflow 1

Una entrada típica enumera un ID numérico en el campo Propietario: accounts.google.com:NUMERIC_ID. Puedes asignar IDs numéricos a las direcciones de correo electrónico de los usuarios en la página Seguridad > Listar usuarios. Esta página está disponible para los usuarios con el rol de Admin.

Ten en cuenta que la relación entre las identidades de Google (direcciones de correo electrónico) y las cuentas de usuario (IDs de usuario) no es fija.

¿Qué sigue?