Utiliser CeleryKubernetesExecutor

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Cette page explique comment activer CeleryKubernetesExecutor dans Cloud Composer et comment utiliser KubernetesExecutor dans vos DAG.

À propos de CeleryKubernetesExecutor

CeleryKubernetesExecutor est un type d'exécuteur qui peut utiliser CeleryExecutor et KubernetesExecutor en même temps. Airflow sélectionne l'exécuteur en fonction de la file d'attente que vous définissez pour la tâche. Dans un DAG, vous pouvez exécuter certaines tâches avec CeleryExecutor et d'autres avec KubernetesExecutor:

  • CeleryExecutor est optimisé pour l'exécution rapide et évolutive des tâches.
  • KubernetesExecutor est conçu pour exécuter des tâches gourmandes en ressources et des tâches de manière isolée.

CeleryKubernetesExecutor dans Cloud Composer

CeleryKubernetesExecutor dans Cloud Composer permet d'utiliser KubernetesExecutor pour vos tâches. Il n'est pas possible d'utiliser KubernetesExecutor dans Cloud Composer séparément de CeleryKubernetesExecutor.

Cloud Composer exécute les tâches que vous exécutez avec KubernetesExecutor dans le cluster de votre environnement, dans le même espace de noms que les nœuds de calcul Airflow. Ces tâches ont les mêmes liaisons que les nœuds de calcul Airflow et peuvent accéder aux ressources de votre projet.

Les tâches que vous exécutez avec KubernetesExecutor suivent le modèle de tarification Cloud Composer, car les pods associés à ces tâches s'exécutent dans le cluster de votre environnement. Les SKU de calcul Cloud Composer (pour le processeur, la mémoire et le stockage) s'appliquent à ces pods.

Nous vous recommandons d'exécuter des tâches avec CeleryExecutor dans les cas suivants:

  • Le temps de démarrage des tâches est important.
  • Les tâches ne nécessitent pas d'isolation de l'environnement d'exécution et ne consomment pas beaucoup de ressources.

Nous vous recommandons d'exécuter des tâches avec KubernetesExecutor dans les cas suivants:

  • Les tâches nécessitent une isolation de l'environnement d'exécution. Par exemple, afin que les tâches n'entrent pas en concurrence pour la mémoire et le processeur, car elles s'exécutent dans leurs propres pods.
  • Les tâches nécessitent des bibliothèques système supplémentaires (ou des packages PyPI).
  • Les tâches sont gourmandes en ressources, et vous souhaitez contrôler les ressources de processeur et de mémoire disponibles.

Comparaison entre KubernetesExecutor et KubernetesPodOperator

L'exécution de tâches avec KubernetesExecutor est semblable à l'exécution de tâches à l'aide de KubernetesPodOperator. Les tâches sont exécutées dans des pods, ce qui permet une isolation des tâches au niveau du pod et une meilleure gestion des ressources.

Il existe toutefois quelques différences clés:

  • KubernetesExecutor exécute les tâches uniquement dans l'espace de noms Cloud Composer avec gestion des versions de votre environnement. Il n'est pas possible de modifier cet espace de noms dans Cloud Composer. Vous pouvez spécifier un espace de noms dans lequel KubernetesPodOperator exécute les tâches du pod.
  • KubernetesExecutor peut utiliser n'importe quel opérateur Airflow intégré. KubernetesPodOperator n'exécute qu'un script fourni défini par le point d'entrée du conteneur.
  • KubernetesExecutor utilise l'image Docker Cloud Composer par défaut avec les mêmes remplacements d'options de configuration Airflow, variables d'environnement et packages PyPI définis dans votre environnement Cloud Composer.

À propos des images Docker

Par défaut, KubernetesExecutor lance les tâches à l'aide de la même image Docker que celle utilisée par Cloud Composer pour les nœuds de calcul Celery. Il s'agit de l'image Cloud Composer pour votre environnement, avec toutes les modifications que vous avez spécifiées pour votre environnement, telles que les packages PyPI personnalisés ou les variables d'environnement.

Avant de commencer

  • Vous pouvez utiliser CeleryKubernetesExecutor dans Cloud Composer 3.

  • Il n'est pas possible d'utiliser un autre exécuteur que CeleryKubernetesExecutor dans Cloud Composer 3. Cela signifie que vous pouvez exécuter des tâches à l'aide de CeleryExecutor et/ou de KubernetesExecutor dans un même DAG, mais qu'il n'est pas possible de configurer votre environnement pour n'utiliser que KubernetesExecutor ou CeleryExecutor.

Configurer CeleryKubernetesExecutor

Vous pouvez remplacer les options de configuration Airflow existantes liées à KubernetesExecutor:

  • [kubernetes]worker_pods_creation_batch_size

    Cette option définit le nombre d'appels de création de pods de nœuds de calcul Kubernetes par boucle de programmeur. La valeur par défaut est 1. Un seul pod est donc lancé par pulsation du programmeur. Si vous utilisez beaucoup KubernetesExecutor, nous vous recommandons d'augmenter cette valeur.

  • [kubernetes]worker_pods_pending_timeout

    Cette option définit, en secondes, la durée pendant laquelle un nœud de calcul peut rester à l'état Pending (le pod est en cours de création) avant d'être considéré comme ayant échoué. La valeur par défaut est de 5 minutes.

Exécuter des tâches avec KubernetesExecutor ou CeleryExecutor

Vous pouvez exécuter des tâches à l'aide de CeleryExecutor et/ou de KubernetesExecutor dans un même DAG:

  • Pour exécuter une tâche avec KubernetesExecutor, spécifiez la valeur kubernetes dans le paramètre queue de la tâche.
  • Pour exécuter une tâche avec CeleryExecutor, omettez le paramètre queue.

L'exemple suivant exécute la tâche task-kubernetes à l'aide de KubernetesExecutor et la tâche task-celery avec CeleryExecutor:

import datetime
import airflow
from airflow.operators.python_operator import PythonOperator

with airflow.DAG(
  "composer_sample_celery_kubernetes",
  start_date=datetime.datetime(2022, 1, 1),
  schedule_interval="@daily") as dag:

  def kubernetes_example():
      print("This task runs using KubernetesExecutor")

  def celery_example():
      print("This task runs using CeleryExecutor")

  # To run with KubernetesExecutor, set queue to kubernetes
  task_kubernetes = PythonOperator(
    task_id='task-kubernetes',
    python_callable=kubernetes_example,
    dag=dag,
    queue='kubernetes')

  # To run with CeleryExecutor, omit the queue argument
  task_celery = PythonOperator(
    task_id='task-celery',
    python_callable=celery_example,
    dag=dag)

  task_kubernetes >> task_celery

Exécuter les commandes de CLI Airflow associées à KubernetesExecutor

Vous pouvez exécuter plusieurs commandes de CLI Airflow associées à KubernetesExecutor à l'aide de gcloud.

Personnaliser la spécification du pod de nœud de calcul

Vous pouvez personnaliser la spécification du pod de nœud de calcul en la transmettant dans le paramètre executor_config d'une tâche. Vous pouvez l'utiliser pour définir des exigences personnalisées en termes de processeur et de mémoire.

Vous pouvez remplacer l'intégralité de la spécification du pod de nœuds de calcul utilisée pour exécuter une tâche. Pour récupérer la spécification de pod d'une tâche utilisée par KubernetesExecutor, vous pouvez exécuter la commande kubernetes generate-dag-yaml de la CLI Airflow.

Pour en savoir plus sur la personnalisation des spécifications des pods de nœuds de calcul, consultez la documentation Airflow.

L'exemple suivant illustre une tâche qui utilise la spécification de pod de nœuds de calcul personnalisés:

PythonOperator(
    task_id='custom-spec-example',
    python_callable=f,
    dag=dag,
    queue='kubernetes',
    executor_config={
        'pod_override': k8s.V1Pod(
            spec=k8s.V1PodSpec(
                containers=[
                    k8s.V1Container(
                        name='base',
                        resources=k8s.V1ResourceRequirements(requests={
                            'cpu': '500m',
                            'memory': '1000Mi',
                        })
                    ),
                ],
            ),
        )
    },
)

Afficher les journaux des tâches

Les journaux des tâches exécutées par KubernetesExecutor sont disponibles dans l'onglet Logs (Journaux), ainsi que les journaux des tâches exécutées par CeleryExecutor:

  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 Journaux.

  4. Accédez à Tous les journaux > Journaux Airflow > Nœuds de calcul.

  5. Les nœuds de calcul nommés airflow-k8s-worker exécutent des tâches KubernetesExecutor. Pour rechercher les journaux d'une tâche spécifique, vous pouvez utiliser un ID de DAG ou un ID de tâche comme mot clé dans la recherche.

Étapes suivantes