• Home
• airflow.providers.cncf.kubernetes
• airflow.providers.cncf.kubernetes.utils
• airflow.providers.cncf.kubernetes.utils.pod_manager

airflow.providers.cncf.kubernetes.utils.pod_manager

Launches PODs.

Attributes

EMPTY_XCOM_RESULT

Sentinel for no xcom result.

Exceptions

PodLaunchFailedException	When pod launching fails in KubernetesPodOperator.
PodLaunchTimeoutException	When pod does not leave the Pending phase within specified timeout.
PodNotFoundException	Expected pod does not exist in kube-api.

Classes

PodPhase	Possible pod phases.
PodOperatorHookProtocol	Protocol to define methods relied upon by KubernetesPodOperator.
PodLogsConsumer	Responsible for pulling pod logs from a stream with checking a container status before reading data.
PodLoggingStatus	Return the status of the pod and last log time when exiting from fetch_container_logs.
PodManager	Create, monitor, and otherwise interact with Kubernetes pods for use with the KubernetesPodOperator.
OnFinishAction	Action to take when the pod finishes.

Functions

should_retry_start_pod(exception)	Check if an Exception indicates a transient error and warrants retrying.
get_container_status(pod, container_name)	Retrieve container status.
container_is_running(pod, container_name)	Examine V1Pod pod to determine whether container_name is running.
container_is_completed(pod, container_name)	Examine V1Pod pod to determine whether container_name is completed.
container_is_succeeded(pod, container_name)	Examine V1Pod pod to determine whether container_name is completed and succeeded.
container_is_wait(pod, container_name)	Examine V1Pod pod to determine whether container_name is waiting.
container_is_terminated(pod, container_name)	Examine V1Pod pod to determine whether container_name is terminated.
get_container_termination_message(pod, container_name)
check_exception_is_kubernetes_api_unauthorized(exc)
is_log_group_marker(line)	Check if the line is a log group marker like ::group:: or ::endgroup::.

Module Contents

airflow.providers.cncf.kubernetes.utils.pod_manager.EMPTY_XCOM_RESULT = '__airflow_xcom_result_empty__'

Sentinel for no xcom result.

exception airflow.providers.cncf.kubernetes.utils.pod_manager.PodLaunchFailedException

Bases: airflow.exceptions.AirflowException

When pod launching fails in KubernetesPodOperator.

airflow.providers.cncf.kubernetes.utils.pod_manager.should_retry_start_pod(exception)

Check if an Exception indicates a transient error and warrants retrying.

class airflow.providers.cncf.kubernetes.utils.pod_manager.PodPhase

Possible pod phases.

See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase.

PENDING = 'Pending'

RUNNING = 'Running'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

terminal_states

class airflow.providers.cncf.kubernetes.utils.pod_manager.PodOperatorHookProtocol

Bases: Protocol

Protocol to define methods relied upon by KubernetesPodOperator.

Subclasses of KubernetesPodOperator, such as GKEStartPodOperator, may use hooks that don’t extend KubernetesHook. We use this protocol to document the methods used by KPO and ensure that these methods exist on such other hooks.

property core_v1_client: kubernetes.client.CoreV1Api

Get authenticated client object.

property is_in_cluster: bool

Expose whether the hook is configured with load_incluster_config or not.

get_pod(name, namespace)

Read pod object from kubernetes API.

get_namespace()

Return the namespace that defined in the connection.

get_xcom_sidecar_container_image()

Return the xcom sidecar image that defined in the connection.

get_xcom_sidecar_container_resources()

Return the xcom sidecar resources that defined in the connection.

airflow.providers.cncf.kubernetes.utils.pod_manager.get_container_status(pod, container_name)

Retrieve container status.

airflow.providers.cncf.kubernetes.utils.pod_manager.container_is_running(pod, container_name)

Examine V1Pod pod to determine whether container_name is running.

If that container is present and running, returns True. Returns False otherwise.

airflow.providers.cncf.kubernetes.utils.pod_manager.container_is_completed(pod, container_name)

Examine V1Pod pod to determine whether container_name is completed.

If that container is present and completed, returns True. Returns False otherwise.

airflow.providers.cncf.kubernetes.utils.pod_manager.container_is_succeeded(pod, container_name)

Examine V1Pod pod to determine whether container_name is completed and succeeded.

If that container is present and completed and succeeded, returns True. Returns False otherwise.

airflow.providers.cncf.kubernetes.utils.pod_manager.container_is_wait(pod, container_name)

Examine V1Pod pod to determine whether container_name is waiting.

If that container is present and waiting, returns True. Returns False otherwise.

airflow.providers.cncf.kubernetes.utils.pod_manager.container_is_terminated(pod, container_name)

Examine V1Pod pod to determine whether container_name is terminated.

If that container is present and terminated, returns True. Returns False otherwise.

airflow.providers.cncf.kubernetes.utils.pod_manager.get_container_termination_message(pod, container_name)

airflow.providers.cncf.kubernetes.utils.pod_manager.check_exception_is_kubernetes_api_unauthorized(exc)

exception airflow.providers.cncf.kubernetes.utils.pod_manager.PodLaunchTimeoutException

Bases: airflow.exceptions.AirflowException

When pod does not leave the Pending phase within specified timeout.

exception airflow.providers.cncf.kubernetes.utils.pod_manager.PodNotFoundException

Bases: airflow.exceptions.AirflowException

Expected pod does not exist in kube-api.

class airflow.providers.cncf.kubernetes.utils.pod_manager.PodLogsConsumer(response, pod, pod_manager, container_name, post_termination_timeout=120, read_pod_cache_timeout=120)

Responsible for pulling pod logs from a stream with checking a container status before reading data.

This class is a workaround for the issue https://github.com/apache/airflow/issues/23497.

Parameters:

• response (urllib3.response.HTTPResponse) – HTTP response with logs

• pod (kubernetes.client.models.v1_pod.V1Pod) – Pod instance from Kubernetes client

• pod_manager (PodManager) – Pod manager instance

• container_name (str) – Name of the container that we’re reading logs from

• post_termination_timeout (int) – (Optional) The period of time in seconds representing for how long time logs are available after the container termination.

• read_pod_cache_timeout (int) – (Optional) The container’s status cache lifetime. The container status is cached to reduce API calls.

response

pod

pod_manager

container_name

post_termination_timeout = 120

last_read_pod_at = None

read_pod_cache = None

read_pod_cache_timeout = 120

__iter__()

Yield log items divided by the ‘n’ symbol.

logs_available()

read_pod()

class airflow.providers.cncf.kubernetes.utils.pod_manager.PodLoggingStatus

Return the status of the pod and last log time when exiting from fetch_container_logs.

running: bool

last_log_time: pendulum.DateTime | None

class airflow.providers.cncf.kubernetes.utils.pod_manager.PodManager(kube_client, callbacks=None)

Bases: airflow.utils.log.logging_mixin.LoggingMixin

Create, monitor, and otherwise interact with Kubernetes pods for use with the KubernetesPodOperator.

run_pod_async(pod, **kwargs)

Run POD asynchronously.

delete_pod(pod)

Delete POD.

create_pod(pod)

Launch the pod asynchronously.

await_pod_start(pod, startup_timeout=120, startup_check_interval=1)

Wait for the pod to reach phase other than Pending.

Parameters:

• pod (kubernetes.client.models.v1_pod.V1Pod)

• startup_timeout (int) – Timeout (in seconds) for startup of the pod (if pod is pending for too long, fails task)

• startup_check_interval (int) – Interval (in seconds) between checks

Returns:

Return type:

None

fetch_container_logs(pod, container_name, *, follow=False, since_time=None, post_termination_timeout=120)

Follow the logs of container and stream to airflow logging.

Returns when container exits.

Between when the pod starts and logs being available, there might be a delay due to CSR not approved and signed yet. In such situation, ApiException is thrown. This is why we are retrying on this specific exception.

fetch_requested_init_container_logs(pod, init_containers, follow_logs=False)

Follow the logs of containers in the specified pod and publish it to airflow logging.

Returns when all the containers exit.

fetch_requested_container_logs(pod, containers, follow_logs=False)

Follow the logs of containers in the specified pod and publish it to airflow logging.

Returns when all the containers exit.

await_container_completion(pod, container_name, polling_time=1)

Wait for the given container in the given pod to be completed.

Parameters:

• pod (kubernetes.client.models.v1_pod.V1Pod) – pod spec that will be monitored

• container_name (str) – name of the container within the pod to monitor

• polling_time (float) – polling time between two container status checks. Defaults to 1s.

await_pod_completion(pod, istio_enabled=False, container_name='base')

Monitor a pod and return the final state.

Parameters:

• istio_enabled (bool) – whether istio is enabled in the namespace

• pod (kubernetes.client.models.v1_pod.V1Pod) – pod spec that will be monitored

• container_name (str) – name of the container within the pod

Returns:

tuple[State, str | None]

Return type:

kubernetes.client.models.v1_pod.V1Pod

parse_log_line(line)

Parse K8s log line and returns the final state.

Parameters:

line (str) – k8s log line

Returns:

timestamp and log message

Return type:

tuple[pendulum.DateTime | None, str]

container_is_running(pod, container_name)

Read pod and checks if container is running.

container_is_terminated(pod, container_name)

Read pod and checks if container is terminated.

read_pod_logs(pod, container_name, tail_lines=None, timestamps=False, since_seconds=None, follow=True, post_termination_timeout=120, **kwargs)

Read log from the POD.

get_init_container_names(pod)

Return container names from the POD except for the airflow-xcom-sidecar container.

get_container_names(pod)

Return container names from the POD except for the airflow-xcom-sidecar container.

read_pod_events(pod)

Read events from the POD.

read_pod(pod)

Read POD information.

await_xcom_sidecar_container_start(pod, timeout=900, log_interval=30)

Check if the sidecar container has reached the ‘Running’ state before performing do_xcom_push.

extract_xcom(pod)

Retrieve XCom value and kill xcom sidecar container.

extract_xcom_json(pod)

Retrieve XCom value and also check if xcom json is valid.

extract_xcom_kill(pod)

Kill xcom sidecar container.

class airflow.providers.cncf.kubernetes.utils.pod_manager.OnFinishAction

Bases: str, enum.Enum

Action to take when the pod finishes.

KEEP_POD = 'keep_pod'

DELETE_POD = 'delete_pod'

DELETE_SUCCEEDED_POD = 'delete_succeeded_pod'

airflow.providers.cncf.kubernetes.utils.pod_manager.is_log_group_marker(line)

Check if the line is a log group marker like ::group:: or ::endgroup::.

Previous Next

Was this entry helpful?