• Home
• airflow.providers.cncf.kubernetes
• airflow.providers.cncf.kubernetes.hooks
• airflow.providers.cncf.kubernetes.hooks.kubernetes

airflow.providers.cncf.kubernetes.hooks.kubernetes

Module Contents

Classes

KubernetesHook	Creates Kubernetes API connection.
AsyncKubernetesHook	Hook to use Kubernetes SDK asynchronously.

Attributes

LOADING_KUBE_CONFIG_FILE_RESOURCE

airflow.providers.cncf.kubernetes.hooks.kubernetes.LOADING_KUBE_CONFIG_FILE_RESOURCE = 'Loading Kubernetes configuration file kube_config from {}...'

class airflow.providers.cncf.kubernetes.hooks.kubernetes.KubernetesHook(conn_id=default_conn_name, client_configuration=None, cluster_context=None, config_file=None, in_cluster=None, disable_verify_ssl=None, disable_tcp_keepalive=None)

Bases: airflow.hooks.base.BaseHook, airflow.providers.cncf.kubernetes.utils.pod_manager.PodOperatorHookProtocol

Creates Kubernetes API connection.

• use in cluster configuration by using extra field in_cluster in connection

• use custom config by providing path to the file using extra field kube_config_path in connection

• use custom configuration by providing content of kubeconfig file via

  extra field kube_config in connection

• use default config by providing no extras

This hook check for configuration option in the above order. Once an option is present it will use this configuration.

See also

For more information about Kubernetes connection: Kubernetes cluster Connection

Parameters

• conn_id (str | None) – The kubernetes connection to Kubernetes cluster.

• client_configuration (kubernetes.client.Configuration | None) – Optional dictionary of client configuration params. Passed on to kubernetes client.

• cluster_context (str | None) – Optionally specify a context to use (e.g. if you have multiple in your kubeconfig.

• config_file (str | None) – Path to kubeconfig file.

• in_cluster (bool | None) – Set to True if running from within a kubernetes cluster.

• disable_verify_ssl (bool | None) – Set to True if SSL verification should be disabled.

• disable_tcp_keepalive (bool | None) – Set to True if you want to disable keepalive logic.

property is_in_cluster: bool

Expose whether the hook is configured with load_incluster_config or not.

conn_name_attr = 'kubernetes_conn_id'

default_conn_name = 'kubernetes_default'

conn_type = 'kubernetes'

hook_name = 'Kubernetes Cluster Connection'

DEFAULT_NAMESPACE = 'default'

classmethod get_connection_form_widgets()

Return connection widgets to add to connection form.

classmethod get_ui_field_behaviour()

Return custom field behaviour.

classmethod get_connection(conn_id)

Return requested connection.

If missing and conn_id is “kubernetes_default”, will return empty connection so that hook will default to cluster-derived credentials.

conn_extras()

get_conn()

Return kubernetes api session for use with requests.

api_client()

Cached Kubernetes API client.

core_v1_client()

Get authenticated client object.

custom_object_client()

create_custom_object(group, version, plural, body, namespace=None)

Create custom resource definition object in Kubernetes.

Parameters

• group (str) – api group

• version (str) – api version

• plural (str) – api plural

• body (str | dict) – crd object definition

• namespace (str | None) – kubernetes namespace

get_custom_object(group, version, plural, name, namespace=None)

Get custom resource definition object from Kubernetes.

Parameters

• group (str) – api group

• version (str) – api version

• plural (str) – api plural

• name (str) – crd object name

• namespace (str | None) – kubernetes namespace

delete_custom_object(group, version, plural, name, namespace=None, **kwargs)

Delete custom resource definition object from Kubernetes.

Parameters

• group (str) – api group

• version (str) – api version

• plural (str) – api plural

• name (str) – crd object name

• namespace (str | None) – kubernetes namespace

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.

get_pod_log_stream(pod_name, container='', namespace=None)

Retrieve a log stream for a container in a kubernetes pod.

Parameters

• pod_name (str) – pod name

• container (str | None) – container name

• namespace (str | None) – kubernetes namespace

get_pod_logs(pod_name, container='', namespace=None)

Retrieve a container’s log from the specified pod.

Parameters

• pod_name (str) – pod name

• container (str | None) – container name

• namespace (str | None) – kubernetes namespace

get_pod(name, namespace)

Read pod object from kubernetes API.

get_namespaced_pod_list(label_selector='', namespace=None, watch=False, **kwargs)

Retrieve a list of Kind pod which belong default kubernetes namespace.

Parameters

• label_selector (str | None) – A selector to restrict the list of returned objects by their labels

• namespace (str | None) – kubernetes namespace

• watch (bool) – Watch for changes to the described resources and return them as a stream

class airflow.providers.cncf.kubernetes.hooks.kubernetes.AsyncKubernetesHook(*args, **kwargs)

Bases: KubernetesHook

Hook to use Kubernetes SDK asynchronously.

async get_conn_extras()

async get_conn()

async get_pod(name, namespace)

Get pod’s object.

Parameters

• name (str) – Name of the pod.

• namespace (str) – Name of the pod’s namespace.

async delete_pod(name, namespace)

Delete pod’s object.

Parameters

• name (str) – Name of the pod.

• namespace (str) – Name of the pod’s namespace.

async read_logs(name, namespace)

Read logs inside the pod while starting containers inside.

All the logs will be outputted with its timestamp to track the logs after the execution of the pod is completed. The method is used for async output of the logs only in the pod failed it execution or the task was cancelled by the user.

Parameters

• name (str) – Name of the pod.

• namespace (str) – Name of the pod’s namespace.

Previous Next

Was this entry helpful?