Accéder à l'interface utilisateur Web Apache Airflow

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Apache Airflow comprend une interface utilisateur Web qui vous permet de gérer les workflows (DAG), de gérer l'environnement Airflow et d'effectuer des tâches d'administration. Par exemple, vous pouvez utiliser l'interface Web pour examiner la progression d'un DAG, configurer une nouvelle connexion de données ou consulter les journaux issus des exécutions précédentes du DAG.

Serveur Web Airflow

Chaque environnement Cloud Composer dispose d'un serveur Web qui exécute l'interface Web Airflow. Le serveur Web fait partie de l'architecture de l'environnement Cloud Composer.

Avant de commencer

• Vous devez disposer d'un rôle permettant d'afficher les environnements Cloud Composer. Pour plus d'informations, consultez la section Contrôle des accès.

• Lors de la création d'un environnement, Cloud Composer configure l'URL du serveur Web qui exécute l'interface Web Airflow. L'URL n'est pas personnalisable.

• Cloud Composer 2 est compatible avec le contrôle des accès à l'interface utilisateur Airflow. (Contrôle des accès basé sur les rôles Airflow) pour l'interface Web Airflow.

• Si l'option Commandes des API > Applications tierces non configurées > Ne pas autoriser les utilisateurs à accéder aux applications tierces est activée dans Google Workspace et que l'application Apache Airflow dans Cloud Composer n'est pas explicitement autorisée, les utilisateurs ne peuvent pas accéder à l'interface utilisateur d'Airflow, sauf s'ils autorisent explicitement l'application. Pour autoriser l'accès, suivez les étapes décrites dans la section Autoriser l'accès à l'interface utilisateur Airflow dans Google Workspace.

Accéder à l'interface Web Airflow

Le serveur Web Airflow s'exécute en tant que charge de travail dans le cluster de votre environnement. Le serveur Web est déployé sur le domaine composer.googleusercontent.com et permet d'accéder à l'interface Web Airflow.

Cloud Composer 2 permet d'accéder à l'interface en fonction de l'identité des utilisateurs et des liaisons de stratégie IAM définies pour les utilisateurs. Par rapport à Cloud Composer 1, Cloud Composer 2 utilise un mécanisme différent qui ne repose pas sur Identity-Aware Proxy.

Accéder à l'interface Web depuis la console Google Cloud

Pour accéder à l'interface Web Airflow depuis la console Google Cloud:

1. Dans la console Google Cloud, accédez à la page Environnements.

   Accéder à la page Environnements

2. Dans la colonne Serveur Web Airflow, cliquez sur le lien Airflow correspondant à votre environnement.

Limiter l'accès au serveur Web Airflow

Les environnements Composer vous permettent de limiter l'accès au serveur Web Airflow:

• Vous pouvez bloquer tout accès ou autoriser l'accès depuis des adresses IPv4 ou IPv6 externes spécifiques Plages d'adresses IP.
• Il n'est pas possible de configurer les plages d'adresses IP autorisées à l'aide d'adresses IP privées.

Récupérer l'URL de l'interface Web via l'outil de ligne de commande gcloud

Vous pouvez accéder à l'interface Web Airflow depuis n'importe quel navigateur Web. Pour obtenir l'URL de l'interface Web, saisissez la commande gcloud suivante :

gcloud composer environments describe ENVIRONMENT_NAME \
  --location LOCATION

Remplacez les éléments suivants :

• ENVIRONMENT_NAME : nom de votre environnement
• LOCATION : région où se trouve l'environnement.

La commande gcloud affiche les propriétés d'un environnement Cloud Composer, y compris les URL de l'interface Web. Les URL sont répertoriées en tant que airflowUri et airflowByoidUri :

• L'adresse URL airflowUri est utilisée par les comptes Google.
• L'adresse URL airflowByoidUri est utilisée par les identités externes si vous configurez la fédération des identités des employés dans votre projet.

config:
  airflowUri: https://example-dot-us-central1.composer.googleusercontent.com
  airflowByoidUri: https://example-dot-us-central1.composer.byoid.googleusercontent.com

Redémarrer le serveur Web

Preview — Web server restarting

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" dans la section "Conditions d'utilisation générales" des Conditions spécifiques au service. Les fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une assistance limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Lors du débogage ou du dépannage des environnements Cloud Composer, certains problèmes peuvent être résolus en redémarrant le serveur Web Airflow. Vous pouvez redémarrer le serveur Web à l'aide de l'API restartWebServer ou de la commande gcloud restart-web-server :

gcloud beta composer environments restart-web-server ENVIRONMENT_NAME \
  --location=LOCATION

Configurer l'accès réseau au serveur Web

Les paramètres d'accès au serveur Web Airflow ne dépendent pas du type de votre environnement. Vous configurez plutôt l'accès au serveur Web séparément. Par exemple, un environnement d'adresse IP privée peut toujours laisser l'interface utilisateur d'Airflow accessible depuis Internet.

Il n'est pas possible de configurer les plages d'adresses IP autorisées à l'aide d'adresses IP privées.

Remarque : Le serveur Web Airflow de votre environnement est toujours protégé par IAM, quelles que soient les plages d'adresses IP autorisées à y accéder.

Attention :Dans certains cas, les modifications apportées aux paramètres d'accès au serveur Web à 10 minutes pour se propager.

Console

1. Dans la console Google Cloud, accédez à la page Environnements.

   Accéder à la page Environnements

2. Dans la liste des environnements, cliquez sur le nom de votre environnement. La page Détails de l'environnement s'ouvre.

3. Accédez à l'onglet Configuration de l'environnement.

4. Dans la section Configuration réseau, recherchez l'élément Contrôle de l'accès au serveur Web, puis cliquez sur Modifier.

5. Dans la boîte de dialogue Contrôle de l'accès réseau du serveur Web:

   • Pour autoriser l'accès au serveur Web Airflow à partir de toutes les adresses IP, sélectionnez Autoriser l'accès à partir de toutes les adresses IP.

   • Pour limiter l'accès à des plages d'adresses IP spécifiques, sélectionnez Autoriser l'accès uniquement depuis des adresses IP spécifiques. Dans le champ Plage d'adresses IP, spécifiez une plage d'adresses IP au format CIDR. Dans le champ Description, spécifiez une description facultative pour cette plage. Si vous souhaitez spécifier plusieurs plages, cliquez sur Ajouter une plage d'adresses IP.

   • Pour refuser l'accès pour toutes les adresses IP, sélectionnez Autoriser l'accès uniquement depuis des adresses IP spécifiques, puis cliquez sur Supprimer l'élément à côté de l'entrée de plage vide.

gcloud

Lorsque vous mettez à jour un environnement, les arguments suivants contrôlent le serveur Web paramètres d'accès:

• --web-server-allow-all fournit un accès à Airflow à partir de toutes les adresses IP. Il s'agit de l'option par défaut.

• --web-server-allow-ip limite l'accès à des plages d'adresses IP sources spécifiques. Pour spécifier plusieurs plages d'adresses IP, utilisez cet argument plusieurs fois.

• --web-server-deny-all interdit l'accès pour toutes les adresses IP.

Remarque : Le serveur Web Airflow de votre environnement est toujours protégé par IAM, quelles que soient les plages d'adresses IP autorisées à y accéder.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --web-server-allow-ip ip_range=WS_IP_RANGE,description=WS_RANGE_DESCRIPTION

Remplacez les éléments suivants :

• ENVIRONMENT_NAME : nom de votre environnement
• LOCATION: région dans laquelle se trouve l'environnement.
• WS_IP_RANGE : plage d'adresses IP, au format CIDR, pouvant accéder à l'interface utilisateur d'Airflow.
• WS_RANGE_DESCRIPTION: description de la plage d'adresses IP.

Exemple :

gcloud composer environments update example-environment \
    --location us-central1 \
    --web-server-allow-ip ip_range=192.0.2.0/24,description="office net 1" \
    --web-server-allow-ip ip_range=192.0.4.0/24,description="office net 3"

API

1. Créez une requête API [environments.patch][api-patch].

2. Dans cette requête :

   1. Dans le paramètre updateMask, spécifiez le masque config.webServerNetworkAccessControl.

   2. Dans le corps de la requête, spécifiez la manière dont les journaux des tâches Airflow doivent être enregistré:

      • Pour permettre l'accès à Airflow à partir de toutes les adresses IP, spécifiez élément config vide (webServerNetworkAccessControl ne doit pas être présent).

      • Pour limiter l'accès à des plages d'adresses IP spécifiques, spécifiez une ou plusieurs plages dans allowedIpRanges.

      • Pour interdire l'accès pour toutes les adresses IP, spécifiez un élément webServerNetworkAccessControl vide. La L'élément webServerNetworkAccessControl doit être présent, mais ne doit pas contenir d'élément allowedIpRanges.

Remarque : Le serveur Web Airflow de votre environnement est toujours protégé par IAM, quelles que soient les plages d'adresses IP autorisées à y accéder.

{
  "config": {
    "webServerNetworkAccessControl": {
      "allowedIpRanges": [
        {
          "value": "WS_IP_RANGE",
          "description": "WS_RANGE_DESCRIPTION"
        }
      ]
    }
  }
}

Remplacez les éléments suivants :

• WS_IP_RANGE : plage d'adresses IP, au format CIDR, pouvant accéder à l'interface utilisateur d'Airflow.
• WS_RANGE_DESCRIPTION: description de la plage d'adresses IP.

Exemple :

// PATCH https://composer.googleapis.com/v1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.webServerNetworkAccessControl

{
  "config": {
    "webServerNetworkAccessControl": {
      "allowedIpRanges": [
        {
          "value": "192.0.2.0/24",
          "description": "office net 1"
        },
        {
          "value": "192.0.4.0/24",
          "description": "office net 3"
        }
      ]
    }
  }
}

Terraform

Dans le bloc allowed_ip_range, dans web_server_network_access_control spécifier les plages d'adresses IP autorisées à accéder au serveur Web.

Remarque : Le serveur Web Airflow de votre environnement est toujours protégé par IAM, quelles que soient les plages d'adresses IP autorisées à y accéder.

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {

    web_server_network_access_control {

      allowed_ip_range {
        value = "WS_IP_RANGE"
        description = "WS_RANGE_DESCRIPTION"
      }

    }

  }
}

Remplacez :

• WS_IP_RANGE par la plage d'adresses IP, au format CIDR, pouvant accéder à l'interface utilisateur d'Airflow.
• WS_RANGE_DESCRIPTION par la description de la plage d'adresses IP.

Exemple :

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "example-environment"
  region = "us-central1"

  config {

    web_server_network_access_control {
      allowed_ip_range {
        value = "192.0.2.0/24"
        description = "office net 1"
      },
      allowed_ip_range {
        value = "192.0.4.0/24"
        description = "office net 3"
      }

    }
}

Étape suivante

• Contrôle des accès à l'interface utilisateur d'Airflow
• Résoudre les problèmes liés au serveur Web Airflow