Add Examples and documentation for pod_template_file feature #10916
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dimberman
changed the title
dimberman
force-pushed
the
pod_template_file_examples
branch
3 times, most recently
from
042ba02
to
32a5054
Compare
mik-laj
reviewed
Sep 14, 2020
docs/executor/kubernetes.rst
Outdated
| pod_template_file | ||
| ################# | ||
|
|
||
| As of Airflow 1.10.12, users can now use a pod_template_file setting in their airflow.cfg to form the basis of |
There was a problem hiding this comment.
Suggested change
| As of Airflow 1.10.12, users can now use a pod_template_file setting in their airflow.cfg to form the basis of | |
| As of Airflow 1.10.12, users can now use a ``pod_template_file`` option in ``XXX`` section in their airflow.cfg to form the basis of |
mik-laj
reviewed
Sep 14, 2020
docs/executor/kubernetes.rst
Outdated
| their KubernetesExecutor pods. This process is faster and easier to modify. | ||
|
|
||
| We include multiple examples of working pod operators below, but we would also like to explain a few necessary components | ||
| if you want to customize your pod_template_files. As long as you have these components, every other element |
There was a problem hiding this comment.
Suggested change
| if you want to customize your pod_template_files. As long as you have these components, every other element | |
| if you want to customize your Pod template files. As long as you have these components, every other element |
mik-laj
reviewed
Sep 14, 2020
docs/executor/kubernetes.rst
Outdated
|
|
||
| Airflow uses the ``pod_template_file`` by making certain assumptions about the structure of the template. | ||
| When airflow creates the worker pod's command, it assumes that the airflow worker container part exists | ||
| at the beginning of the container array. It then assumes that the container is named "base" |
There was a problem hiding this comment.
Suggested change
| at the beginning of the container array. It then assumes that the container is named "base" | |
| at the beginning of the container array. It then assumes that the container is named ``"base"`` |
mik-laj
reviewed
Sep 14, 2020
docs/executor/kubernetes.rst
Outdated
| It's important to note while Airflow overwrites these fields, they **can not be left blank**. | ||
| If these fields do not exist, kubernetes can not load the yaml into a Kuberentes V1Pod | ||
|
|
||
| 2. Each airflow ``pod_template_file`` must have a container named ``base`` at the ``pod.spec.containers[0]`` position |
There was a problem hiding this comment.
Suggested change
| 2. Each airflow ``pod_template_file`` must have a container named ``base`` at the ``pod.spec.containers[0]`` position | |
| 2. Each airflow ``pod_template_file`` must have a container named ``"base"`` at the ``pod.spec.containers[0]`` position |
mik-laj
reviewed
Sep 14, 2020
docs/executor/kubernetes.rst
Outdated
| Airflow uses the ``pod_template_file`` by making certain assumptions about the structure of the template. | ||
| When airflow creates the worker pod's command, it assumes that the airflow worker container part exists | ||
| at the beginning of the container array. It then assumes that the container is named "base" | ||
| when it merges this pod with internal configs. Users are more than welcome to create |
There was a problem hiding this comment.
Suggested change
| when it merges this pod with internal configs. Users are more than welcome to create | |
| when it merges this pod with internal configs. You are more than welcome to create |
See:
https://developers.google.com/style/person
and
Address the reader directly. Use you, instead of the user or they. For more information, see Second person and first person.
dimberman
force-pushed
the
pod_template_file_examples
branch
from
32a5054
to
a5b1d47
Compare
kaxil
reviewed
Sep 14, 2020
kaxil
reviewed
Sep 14, 2020
kaxil
reviewed
Sep 14, 2020
kaxil
reviewed
Sep 14, 2020
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
kaxil
reviewed
Sep 14, 2020
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
kaxil
reviewed
Sep 14, 2020
kaxil
reviewed
Sep 14, 2020
kaxil
reviewed
Sep 14, 2020
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
kaxil
reviewed
Sep 14, 2020
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
kaxil
reviewed
Sep 14, 2020
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
kaxil
reviewed
Sep 14, 2020
airflow/kubernetes_executor_templates/dags_in_image_template.yaml
Outdated
Show resolved
Hide resolved
…rflow into pod_template_file_examples
|
hmm tests are failing |
|
|
@kaxil forgot an |
kaxil
approved these changes
Sep 14, 2020
|
@kaxil fixed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add more documentation on creating and modifying a pod_template_file for users of the KubernetesExecutor
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.