You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "ketozhang (via GitHub)" <gi...@apache.org> on 2024/01/28 07:03:11 UTC
[PR] Fix KPO docs argument precedence [airflow]
ketozhang opened a new pull request, #37047:
URL: https://github.com/apache/airflow/pull/37047
<!--
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/
-->
closes: #35969
<!-- Please keep an empty line above the dashes. -->
---
Fixes the Argument precedence section of KPO docs. Removed incorrect mention of KPO creates pods based off the Airflow connection. It should be full_pod_spec, pod_template_file, then a default `V1Pod(metadata=k8s.V1ObjectMeta())`
--
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 KPO docs argument precedence [airflow]
Posted by "ketozhang (via GitHub)" <gi...@apache.org>.
ketozhang commented on code in PR #37047:
URL: https://github.com/apache/airflow/pull/37047#discussion_r1477605769
##########
docs/apache-airflow-providers-cncf-kubernetes/operators.rst:
##########
@@ -77,8 +77,8 @@ You can print out the Kubernetes manifest for the pod that would be created at r
Argument precedence
^^^^^^^^^^^^^^^^^^^
-When building the pod object, there may be overlap between KPO params, pod spec, template and airflow connection.
-In general, the order of precedence is KPO argument > full pod spec > pod template file > airflow connection.
+When KPO defines the pod object, there may be overlap between the :class:`~airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator` arguments.
+In general, the order of precedence is KPO field-specific arguments (e.g., `secrets`, `cmds`, `affinity`), more general templates``full_pod_spec``, ``pod_template_file``, ``pod_template_dict``, and followed by ``V1Pod``, by default.
Review Comment:
```suggestion
When KPO defines the pod object, there may be overlap between the :class:`~airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator` arguments.
In general, the order of precedence is KPO field-specific arguments (e.g., ``secrets``, ``cmds``, ``affinity``), more general templates ``full_pod_spec``, ``pod_template_file``, ``pod_template_dict``, and followed by ``V1Pod``, by default.
```
--
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 KPO docs argument precedence [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #37047:
URL: https://github.com/apache/airflow/pull/37047#discussion_r1468895610
##########
docs/apache-airflow-providers-cncf-kubernetes/operators.rst:
##########
@@ -77,8 +77,8 @@ You can print out the Kubernetes manifest for the pod that would be created at r
Argument precedence
^^^^^^^^^^^^^^^^^^^
-When building the pod object, there may be overlap between KPO params, pod spec, template and airflow connection.
-In general, the order of precedence is KPO argument > full pod spec > pod template file > airflow connection.
+When KPO defines the pod object, there may be overlap between the :class:`~airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator` arguments.
+In general, the order of precedence is ``full_pod_spec``, ``pod_template_file``, or otherwise the ``V1Pod`` default.
Review Comment:
```suggestion
In general, the order of precedence is ``full_pod_spec``, ``pod_template_file``, or otherwise the ``V1Pod`` default.
```
```suggestion
In general, the order of precedence is ``full_pod_spec``, ``pod_template_file``, followed by ``V1Pod``, by default.
```
--
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 KPO docs argument precedence [airflow]
Posted by "ketozhang (via GitHub)" <gi...@apache.org>.
ketozhang commented on code in PR #37047:
URL: https://github.com/apache/airflow/pull/37047#discussion_r1470039181
##########
docs/apache-airflow-providers-cncf-kubernetes/operators.rst:
##########
@@ -77,8 +77,8 @@ You can print out the Kubernetes manifest for the pod that would be created at r
Argument precedence
^^^^^^^^^^^^^^^^^^^
-When building the pod object, there may be overlap between KPO params, pod spec, template and airflow connection.
-In general, the order of precedence is KPO argument > full pod spec > pod template file > airflow connection.
+When KPO defines the pod object, there may be overlap between the :class:`~airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator` arguments.
+In general, the order of precedence is ``full_pod_spec``, ``pod_template_file``, followed by ``V1Pod``, by default.
Review Comment:
```suggestion
When KPO defines the pod object, there may be overlap between the :class:`~airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator` arguments.
In general, the order of precedence is ``pod_template_file``, ``pod_template_dict``, ``full_pod_spec``, and followed by ``V1Pod``, by default.
```
--
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 KPO docs argument precedence [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #37047:
URL: https://github.com/apache/airflow/pull/37047#issuecomment-1930100941
Okay we finally have a green CI. Shall we send this in @potiuk ?
--
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 KPO docs argument precedence [airflow]
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #37047:
URL: https://github.com/apache/airflow/pull/37047#issuecomment-1913480028
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/docs/apache-airflow/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 KPO docs argument precedence [airflow]
Posted by "dirrao (via GitHub)" <gi...@apache.org>.
dirrao commented on code in PR #37047:
URL: https://github.com/apache/airflow/pull/37047#discussion_r1475580760
##########
docs/apache-airflow-providers-cncf-kubernetes/operators.rst:
##########
@@ -77,8 +77,8 @@ You can print out the Kubernetes manifest for the pod that would be created at r
Argument precedence
^^^^^^^^^^^^^^^^^^^
-When building the pod object, there may be overlap between KPO params, pod spec, template and airflow connection.
-In general, the order of precedence is KPO argument > full pod spec > pod template file > airflow connection.
+When KPO defines the pod object, there may be overlap between the :class:`~airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator` arguments.
+In general, the order of precedence is ``pod_template_file``, ``pod_template_dict``, ``full_pod_spec``, and followed by ``V1Pod``, by default.
Review Comment:
Yes. It looks good to me.
--
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 KPO docs argument precedence [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #37047:
URL: https://github.com/apache/airflow/pull/37047#issuecomment-1923766672
fix to bactics is needed. RST does not like single backticks.
--
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 KPO docs argument precedence [airflow]
Posted by "ketozhang (via GitHub)" <gi...@apache.org>.
ketozhang commented on code in PR #37047:
URL: https://github.com/apache/airflow/pull/37047#discussion_r1471693809
##########
docs/apache-airflow-providers-cncf-kubernetes/operators.rst:
##########
@@ -77,8 +77,8 @@ You can print out the Kubernetes manifest for the pod that would be created at r
Argument precedence
^^^^^^^^^^^^^^^^^^^
-When building the pod object, there may be overlap between KPO params, pod spec, template and airflow connection.
-In general, the order of precedence is KPO argument > full pod spec > pod template file > airflow connection.
+When KPO defines the pod object, there may be overlap between the :class:`~airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator` arguments.
+In general, the order of precedence is ``pod_template_file``, ``pod_template_dict``, ``full_pod_spec``, and followed by ``V1Pod``, by default.
Review Comment:
Thank for the correction. Looking more carefully at
https://github.com/apache/airflow/blob/ba053f79edab54366208aad9d88877a95b789eca/airflow/providers/cncf/kubernetes/operators/pod.py#L900-L914
https://github.com/apache/airflow/blob/ba053f79edab54366208aad9d88877a95b789eca/airflow/providers/cncf/kubernetes/operators/pod.py#L916-L919
https://github.com/apache/airflow/blob/ba053f79edab54366208aad9d88877a95b789eca/airflow/providers/cncf/kubernetes/operators/pod.py#L963
and `PodGenerator.reconcile_pods()`, I agree that's correct.
However, the wording is still quite confusing. KPO arguments is very vague since both `secrets`, `cmds`, `arguments` (what you meant) and `full_pod_spec` are both KPO arguments.
Do you agree with this suggestion?
```suggestion
In general, the order of precedence is KPO field-specific arguments (e.g., `secrets`, `cmds`, `affinity`), more general templates``full_pod_spec``, ``pod_template_file``, ``pod_template_dict``, and followed by ``V1Pod``, by default.
```
--
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 KPO docs argument precedence [airflow]
Posted by "ketozhang (via GitHub)" <gi...@apache.org>.
ketozhang commented on PR #37047:
URL: https://github.com/apache/airflow/pull/37047#issuecomment-1917580816
Perhaps out of scope. `pod_template_file` and `pod_template_dict` is mutually exclusive. If both are specified then `pod_template_dict` is ignored. This should be in the API docs.
--
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 KPO docs argument precedence [airflow]
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal merged PR #37047:
URL: https://github.com/apache/airflow/pull/37047
--
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 KPO docs argument precedence [airflow]
Posted by "dirrao (via GitHub)" <gi...@apache.org>.
dirrao commented on code in PR #37047:
URL: https://github.com/apache/airflow/pull/37047#discussion_r1471103997
##########
docs/apache-airflow-providers-cncf-kubernetes/operators.rst:
##########
@@ -77,8 +77,8 @@ You can print out the Kubernetes manifest for the pod that would be created at r
Argument precedence
^^^^^^^^^^^^^^^^^^^
-When building the pod object, there may be overlap between KPO params, pod spec, template and airflow connection.
-In general, the order of precedence is KPO argument > full pod spec > pod template file > airflow connection.
+When KPO defines the pod object, there may be overlap between the :class:`~airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator` arguments.
+In general, the order of precedence is ``pod_template_file``, ``pod_template_dict``, ``full_pod_spec``, and followed by ``V1Pod``, by default.
Review Comment:
the order of precedence is KPO argument > full_pod_spec > pod_template_file > pod_template_dict > V1Pod
--
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