# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""Manage a Kubernetes Resource."""
from __future__ import annotations
import os
from functools import cached_property
from typing import TYPE_CHECKING, Sequence
import yaml
from kubernetes.utils import create_from_yaml
from airflow.exceptions import AirflowException
from airflow.models import BaseOperator
from airflow.providers.cncf.kubernetes.hooks.kubernetes import KubernetesHook
from airflow.providers.cncf.kubernetes.utils.delete_from import delete_from_yaml
from airflow.providers.cncf.kubernetes.utils.k8s_resource_iterator import k8s_resource_iterator
if TYPE_CHECKING:
from kubernetes.client import ApiClient, CustomObjectsApi
__all__ = ["KubernetesCreateResourceOperator", "KubernetesDeleteResourceOperator"]
class KubernetesResourceBaseOperator(BaseOperator):
"""
Abstract base class for all Kubernetes Resource operators.
:param yaml_conf: string. Contains the kubernetes resources to Create or Delete
:param yaml_conf_file: path to the kubernetes resources file (templated)
:param namespace: string. Contains the namespace to create all resources inside.
The namespace must preexist otherwise the resource creation will fail.
If the API object in the yaml file already contains a namespace definition then
this parameter has no effect.
:param kubernetes_conn_id: The :ref:`kubernetes connection id <howto/connection:kubernetes>`
for the Kubernetes cluster.
:param namespaced: specified that Kubernetes resource is or isn't in a namespace.
This parameter works only when custom_resource_definition parameter is True.
"""
template_fields: Sequence[str] = ("yaml_conf", "yaml_conf_file")
template_fields_renderers = {"yaml_conf": "yaml"}
def __init__(
self,
*,
yaml_conf: str | None = None,
yaml_conf_file: str | None = None,
namespace: str | None = None,
kubernetes_conn_id: str | None = KubernetesHook.default_conn_name,
custom_resource_definition: bool = False,
namespaced: bool = True,
config_file: str | None = None,
**kwargs,
) -> None:
super().__init__(**kwargs)
self._namespace = namespace
self.kubernetes_conn_id = kubernetes_conn_id
self.yaml_conf = yaml_conf
self.yaml_conf_file = yaml_conf_file
self.custom_resource_definition = custom_resource_definition
self.namespaced = namespaced
self.config_file = config_file
if not any([self.yaml_conf, self.yaml_conf_file]):
raise AirflowException("One of `yaml_conf` or `yaml_conf_file` arguments must be provided")
@cached_property
def client(self) -> ApiClient:
return self.hook.api_client
@cached_property
def custom_object_client(self) -> CustomObjectsApi:
return self.hook.custom_object_client
@cached_property
def hook(self) -> KubernetesHook:
hook = KubernetesHook(conn_id=self.kubernetes_conn_id, config_file=self.config_file)
return hook
def get_namespace(self) -> str:
if self._namespace:
return self._namespace
else:
return self.hook.get_namespace() or "default"
def get_crd_fields(self, body: dict) -> tuple[str, str, str, str]:
api_version = body["apiVersion"]
group = api_version[0 : api_version.find("/")]
version = api_version[api_version.find("/") + 1 :]
namespace = None
if body.get("metadata"):
metadata: dict = body.get("metadata", None)
namespace = metadata.get("namespace", None)
if namespace is None:
namespace = self.get_namespace()
plural = body["kind"].lower() + "s"
return group, version, namespace, plural
[docs]class KubernetesCreateResourceOperator(KubernetesResourceBaseOperator):
"""Create a resource in a kubernetes."""
[docs] def create_custom_from_yaml_object(self, body: dict):
group, version, namespace, plural = self.get_crd_fields(body)
if self.namespaced:
self.custom_object_client.create_namespaced_custom_object(group, version, namespace, plural, body)
else:
self.custom_object_client.create_cluster_custom_object(group, version, plural, body)
def _create_objects(self, objects):
if not self.custom_resource_definition:
create_from_yaml(
k8s_client=self.client,
yaml_objects=objects,
namespace=self.get_namespace(),
)
else:
k8s_resource_iterator(self.create_custom_from_yaml_object, objects)
[docs] def execute(self, context) -> None:
if self.yaml_conf:
self._create_objects(yaml.safe_load_all(self.yaml_conf))
elif self.yaml_conf_file and os.path.exists(self.yaml_conf_file):
with open(self.yaml_conf_file) as stream:
self._create_objects(yaml.safe_load_all(stream))
else:
raise AirflowException("File %s not found", self.yaml_conf_file)
[docs]class KubernetesDeleteResourceOperator(KubernetesResourceBaseOperator):
"""Delete a resource in a kubernetes."""
[docs] def delete_custom_from_yaml_object(self, body: dict):
name = body["metadata"]["name"]
group, version, namespace, plural = self.get_crd_fields(body)
if self.namespaced:
self.custom_object_client.delete_namespaced_custom_object(group, version, namespace, plural, name)
else:
self.custom_object_client.delete_cluster_custom_object(group, version, plural, name)
def _delete_objects(self, objects):
if not self.custom_resource_definition:
delete_from_yaml(
k8s_client=self.client,
yaml_objects=objects,
namespace=self.get_namespace(),
)
else:
k8s_resource_iterator(self.delete_custom_from_yaml_object, objects)
[docs] def execute(self, context) -> None:
if self.yaml_conf:
self._delete_objects(yaml.safe_load_all(self.yaml_conf))
elif self.yaml_conf_file and os.path.exists(self.yaml_conf_file):
with open(self.yaml_conf_file) as stream:
self._delete_objects(yaml.safe_load_all(stream))
else:
raise AirflowException("File %s not found", self.yaml_conf_file)
