Skip to content

Template field support for configmaps in the KubernetesPodOperator #36922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hussein-awala merged 7 commits into from
Jan 20, 2024
Merged

Template field support for configmaps in the KubernetesPodOperator #36922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e4dc874
36888 Template field support for configmaps
vizeit Jan 19, 2024
853af48
36888 Add newsfragment - correct format
vizeit Jan 20, 2024
1b33aba
36888 Template field support for configmaps
vizeit Jan 19, 2024
bea6d5e
36888 Add newsfragment - correct format
vizeit Jan 20, 2024
c2714ee
Merge branch 'main' of github.com:vizeit/airflow into main
vizeit Jan 20, 2024
cec5ad4
Remove newsfragment
vizeit Jan 20, 2024
2cb3031
Merge branch 'main' into main
eladkal Jan 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions airflow/providers/cncf/kubernetes/operators/pod.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ class KubernetesPodOperator(BaseOperator):
"volumes",
"volume_mounts",
"cluster_context",
"configmaps",
)
template_fields_renderers = {"env_vars": "py"}

Expand Down Expand Up @@ -307,8 +308,9 @@ def __init__(
if pod_runtime_info_envs:
self.env_vars.extend([convert_pod_runtime_info_env(p) for p in pod_runtime_info_envs])
self.env_from = env_from or []
if configmaps:
self.env_from.extend([convert_configmap(c) for c in configmaps])
self.configmaps = configmaps
if self.configmaps:
self.env_from.extend([convert_configmap(c) for c in self.configmaps])
self.ports = [convert_port(p) for p in ports] if ports else []
self.volume_mounts = [convert_volume_mount(v) for v in volume_mounts] if volume_mounts else []
self.volumes = [convert_volume(volume) for volume in volumes] if volumes else []
Expand Down Expand Up @@ -405,11 +407,13 @@ def _render_nested_template_fields(
elif isinstance(content, k8s.V1ResourceRequirements):
template_fields = ("limits", "requests")
elif isinstance(content, k8s.V1Volume):
template_fields = ("name", "persistent_volume_claim")
template_fields = ("name", "persistent_volume_claim", "config_map")
elif isinstance(content, k8s.V1VolumeMount):
template_fields = ("name", "sub_path")
elif isinstance(content, k8s.V1PersistentVolumeClaimVolumeSource):
template_fields = ("claim_name",)
elif isinstance(content, k8s.V1ConfigMapVolumeSource):
template_fields = ("name",)
else:
template_fields = None

Expand Down
12 changes: 12 additions & 0 deletions tests/providers/cncf/kubernetes/operators/test_pod.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,15 @@ def test_templates(self, create_task_instance_of_operator):
cmds="{{ dag.dag_id }}",
image="{{ dag.dag_id }}",
annotations={"dag-id": "{{ dag.dag_id }}"},
configmaps=["{{ dag.dag_id }}"],
volumes=[
k8s.V1Volume(
name="{{ dag.dag_id }}",
config_map=k8s.V1ConfigMapVolumeSource(
name="{{ dag.dag_id }}", items=[k8s.V1KeyToPath(key="key", path="path")]
),
)
],
)

rendered = ti.render_templates()
Expand All @@ -170,6 +179,9 @@ def test_templates(self, create_task_instance_of_operator):
assert dag_id == ti.task.arguments
assert dag_id == ti.task.env_vars[0]
assert dag_id == rendered.annotations["dag-id"]
assert dag_id == ti.task.configmaps[0]
assert dag_id == rendered.volumes[0].name
assert dag_id == rendered.volumes[0].config_map.name

def run_pod(self, operator: KubernetesPodOperator, map_index: int = -1) -> k8s.V1Pod:
with self.dag_maker(dag_id="dag") as dag:
Expand Down