airflow.providers.cncf.kubernetes.triggers.job¶

Classes¶

KubernetesJobTrigger

KubernetesJobTrigger run on the trigger worker to check the state of Job.

Module Contents¶

class airflow.providers.cncf.kubernetes.triggers.job.KubernetesJobTrigger(job_name, job_namespace, pod_names, pod_namespace, base_container_name, pod_name=None, kubernetes_conn_id=None, poll_interval=10.0, cluster_context=None, config_file=None, in_cluster=None, get_logs=True, do_xcom_push=False)[source]¶

Bases: airflow.triggers.base.BaseTrigger

KubernetesJobTrigger run on the trigger worker to check the state of Job.

Parameters:

job_name (str) – The name of the job.
job_namespace (str) – The namespace of the job.
pod_name (str | None) – The name of the Pod. Parameter is deprecated, please use pod_names instead.
pod_names (list[str]) – The name of the Pods.
pod_namespace (str) – The namespace of the Pod.
base_container_name (str) – The name of the base container in the pod.
kubernetes_conn_id (str | None) – The kubernetes connection id for the Kubernetes cluster.
cluster_context (str | None) – Context that points to kubernetes cluster.
config_file (str | None) – Path to kubeconfig file.
poll_interval (float) – Polling period in seconds to check for the status.
in_cluster (bool | None) – run kubernetes client with in_cluster configuration.
get_logs (bool) – get the stdout of the base container as logs of the tasks.
do_xcom_push (bool) – If True, the content of the file /airflow/xcom/return.json in the container will also be pushed to an XCom when the container completes.

job_name[source]¶

job_namespace[source]¶

pod_namespace[source]¶

base_container_name[source]¶

kubernetes_conn_id = None[source]¶

poll_interval = 10.0[source]¶

cluster_context = None[source]¶

config_file = None[source]¶

in_cluster = None[source]¶

get_logs = True[source]¶

do_xcom_push = False[source]¶

property pod_name[source]¶

serialize()[source]¶

Serialize KubernetesCreateJobTrigger arguments and classpath.

async run()[source]¶

Get current job status and yield a TriggerEvent.

property hook: airflow.providers.cncf.kubernetes.hooks.kubernetes.AsyncKubernetesHook[source]¶

property pod_manager: airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager[source]¶