Skip to content
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

Jump to bottom

Add param docs to KubernetesHook and KubernetesPodOperator (#23955) #24054

Merged
merged 7 commits into from
Jun 6, 2022
Merged

Add param docs to KubernetesHook and KubernetesPodOperator (#23955) #24054

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e120fc7
Add param docs to KubernetesHook and KubernetesPodOperator (#23955)
mariasumedre-3pg May 31, 2022
0d11485
Review finding: fix typo coselects
mariasumedre-3pg May 31, 2022
bc0c9fc
Merge branch 'main' into docs-23955
mariasumedre-3pg Jun 1, 2022
3da3fb8
Review findings: remove unnecessary lines
mariasumedre-3pg Jun 2, 2022
34ffe9b
Review findings: reorder, remove unnecessary lines
mariasumedre-3pg Jun 2, 2022
5dd6b34
Review findings: move env_from after env_vars
mariasumedre-3pg Jun 2, 2022
f9e8320
Merge remote-tracking branch 'upstream/main' into docs-23955
mariasumedre-3pg Jun 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions airflow/providers/cncf/kubernetes/operators/kubernetes_pod.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,12 @@ class KubernetesPodOperator(BaseOperator):
:param labels: labels to apply to the Pod. (templated)
:param startup_timeout_seconds: timeout in seconds to startup the pod.
:param get_logs: get the stdout of the container as logs of the tasks.
:param env_from: (Optional) List of sources to populate environment variables in the container.
The keys defined within a source must be a C_IDENTIFIER.
All invalid keys will be reported as an event when the container is starting.
When a key exists in multiple sources, the value associated with the last source
will take precedence. Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
mariasumedre-3pg marked this conversation as resolved.
Show resolved Hide resolved
:param image_pull_policy: Specify a policy to cache or always pull an image.
:param annotations: non-identifying metadata you can attach to the Pod.
Can be a large range of data, and can include characters
Expand All @@ -120,6 +126,8 @@ class KubernetesPodOperator(BaseOperator):
:param affinity: affinity scheduling rules for the launched pod.
:param config_file: The path to the Kubernetes config file. (templated)
If not specified, default value is ``~/.kube/config``
:param node_selectors: (Deprecated) A dict containing a group of scheduling rules.
Please use node_selector instead.
:param node_selector: A dict containing a group of scheduling rules.
:param image_pull_secrets: Any image pull secrets to be given to the pod.
If more than one secret is required, provide a
Expand All @@ -143,6 +151,12 @@ class KubernetesPodOperator(BaseOperator):
:param priority_class_name: priority class name for the launched Pod
:param termination_grace_period: Termination grace period if task killed in UI,
defaults to kubernetes default
:param pod_runtime_info_envs: (Optional) A list of environment variables,
to be set in the container. Cannot be updated.
mariasumedre-3pg marked this conversation as resolved.
Show resolved Hide resolved
:param configmaps: (Optional) A list of names of config maps from which it collects ConfigMaps
to populate the environment variables with. The contents of the target
ConfigMap's Data field will represent the key-value pairs as environment variables.
Extends env_from.
:param: kubernetes_conn_id: To retrieve credentials for your k8s cluster from an Airflow connection
"""

Expand Down