You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "stephen-bracken (via GitHub)" <gi...@apache.org> on 2025/07/04 16:40:28 UTC
[PR] Fix KubernetesJobOperator.get_or_create_pod() [airflow]
stephen-bracken opened a new pull request, #52885:
URL: https://github.com/apache/airflow/pull/52885
Fix KubernetesJobOperator.get_or_create_pod() sometimes creating duplicate pods.
<!--
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.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
during `execute()` the KubernetesJobOperator attempts to find the pod associated with the Job object using `self.get_or_create_pod()`. If Kubernetes is being slow then the Job object will not create a pod before this method gets called, which will result in the underlying `find_pod()` method returning `None`, and a duplicate headless pod being created for this task.
This PR overrides the `get_or_create_pod()` method in `KubernetesJobOperator` to poll for the pod associated with the Job if one is not created immediately.
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix KubernetesJobOperator.get_or_create_pod() [airflow]
Posted by "stephen-bracken (via GitHub)" <gi...@apache.org>.
stephen-bracken commented on PR #52885:
URL: https://github.com/apache/airflow/pull/52885#issuecomment-3073224451
argh I've messed up the diff for this PR - going to close and reopen as fresh
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix KubernetesJobOperator.get_or_create_pod() [airflow]
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #52885:
URL: https://github.com/apache/airflow/pull/52885#issuecomment-3036855886
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:
- Pay attention to the quality of your code (ruff, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/airflow-core/docs/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/dev/breeze/doc/README.rst) for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#coding-style-and-best-practices).
- Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
Apache Airflow is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix KubernetesJobOperator.get_or_create_pod() [airflow]
Posted by "stephen-bracken (via GitHub)" <gi...@apache.org>.
stephen-bracken commented on code in PR #52885:
URL: https://github.com/apache/airflow/pull/52885#discussion_r2187200009
##########
providers/cncf/kubernetes/src/airflow/providers/cncf/kubernetes/operators/job.py:
##########
@@ -147,6 +147,12 @@ def create_job(self, job_request_obj: k8s.V1Job) -> k8s.V1Job:
return job_request_obj
+ def get_or_create_pod(self, pod_request_obj, context):
+ pod = None
+ while pod is None:
Review Comment:
Good point. I was relying on the task timeout to interrupt this, which is a naive assumption. I can add a static timeout, or add a retry with backoff here or use the activeDeadlineSeconds from the job spec?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix KubernetesJobOperator.get_or_create_pod() [airflow]
Posted by "dominikhei (via GitHub)" <gi...@apache.org>.
dominikhei commented on code in PR #52885:
URL: https://github.com/apache/airflow/pull/52885#discussion_r2185802333
##########
providers/cncf/kubernetes/src/airflow/providers/cncf/kubernetes/operators/job.py:
##########
@@ -147,6 +147,12 @@ def create_job(self, job_request_obj: k8s.V1Job) -> k8s.V1Job:
return job_request_obj
+ def get_or_create_pod(self, pod_request_obj, context):
+ pod = None
+ while pod is None:
Review Comment:
Dosen this risk an infinite loop?
##########
providers/cncf/kubernetes/src/airflow/providers/cncf/kubernetes/operators/job.py:
##########
@@ -147,6 +147,12 @@ def create_job(self, job_request_obj: k8s.V1Job) -> k8s.V1Job:
return job_request_obj
+ def get_or_create_pod(self, pod_request_obj, context):
+ pod = None
+ while pod is None:
Review Comment:
Doesn't this risk an infinite loop?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix KubernetesJobOperator.get_or_create_pod() [airflow]
Posted by "stephen-bracken (via GitHub)" <gi...@apache.org>.
stephen-bracken closed pull request #52885: Fix KubernetesJobOperator.get_or_create_pod()
URL: https://github.com/apache/airflow/pull/52885
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix KubernetesJobOperator.get_or_create_pod() [airflow]
Posted by "dominikhei (via GitHub)" <gi...@apache.org>.
dominikhei commented on code in PR #52885:
URL: https://github.com/apache/airflow/pull/52885#discussion_r2200604863
##########
providers/cncf/kubernetes/tests/unit/cncf/kubernetes/operators/test_job.py:
##########
@@ -484,15 +484,49 @@ def test_task_id_as_name_dag_id_is_ignored(self):
job = k.build_job_request_obj({})
assert re.match(r"job-a-very-reasonable-task-name-[a-z0-9-]+", job.metadata.name) is not None
+ @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.find_pod"))
+ def test_get_or_create_pod(self, mock_find_pod):
+ found_pod = mock.MagicMock()
+ mock_find_pod.side_effect = [None,found_pod]
+ mock_ti = mock.MagicMock()
+ context = dict(ti=mock_ti)
+
+ op = KubernetesJobOperator(
+ task_id="test_task_id"
+ )
+
+ assert op.get_or_create_pod({},context) == found_pod
+
+
@pytest.mark.non_db_test_override
- @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.get_or_create_pod"))
+ @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.find_pod"))
+ @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.build_job_request_obj"))
+ @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.create_job"))
+ @patch(HOOK_CLASS)
+ def test_pod_creation_timeout(self, mock_hook, mock_create_job, mock_build_job_request_obj, mock_find_pod):
Review Comment:
If I am not wrong this tests waits the whole 10s you used as a timeout. Could you mock the behavior, such that the test does not run for 10s or set it to 0?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Fix KubernetesJobOperator.get_or_create_pod() [airflow]
Posted by "stephen-bracken (via GitHub)" <gi...@apache.org>.
stephen-bracken commented on code in PR #52885:
URL: https://github.com/apache/airflow/pull/52885#discussion_r2200726090
##########
providers/cncf/kubernetes/tests/unit/cncf/kubernetes/operators/test_job.py:
##########
@@ -484,15 +484,49 @@ def test_task_id_as_name_dag_id_is_ignored(self):
job = k.build_job_request_obj({})
assert re.match(r"job-a-very-reasonable-task-name-[a-z0-9-]+", job.metadata.name) is not None
+ @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.find_pod"))
+ def test_get_or_create_pod(self, mock_find_pod):
+ found_pod = mock.MagicMock()
+ mock_find_pod.side_effect = [None,found_pod]
+ mock_ti = mock.MagicMock()
+ context = dict(ti=mock_ti)
+
+ op = KubernetesJobOperator(
+ task_id="test_task_id"
+ )
+
+ assert op.get_or_create_pod({},context) == found_pod
+
+
@pytest.mark.non_db_test_override
- @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.get_or_create_pod"))
+ @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.find_pod"))
+ @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.build_job_request_obj"))
+ @patch(JOB_OPERATORS_PATH.format("KubernetesJobOperator.create_job"))
+ @patch(HOOK_CLASS)
+ def test_pod_creation_timeout(self, mock_hook, mock_create_job, mock_build_job_request_obj, mock_find_pod):
Review Comment:
sure, I'll set it to 1
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org