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.

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

Avoid confusion in doc for CeleryKubernetesExecutor #13116

Merged
merged 1 commit into from
Dec 16, 2020

Conversation

XD-DENG
Copy link
Member

@XD-DENG XD-DENG commented Dec 16, 2020

The current docstring around CeleryKubernetesExecutor is not clear enough.

  • Docstring When the queue is 'kubernetes', KubernetesExecutor is selected to run the task is incorrect. The value is configurable, and "kubernetes" is only the default value.
  • In the configuration doc, When the queue of a task is 'kubernetes_queue', ... is inaccurate. Instead, it should be something like When the queue of a task is the value of 'kubernetes_queue', ....

This PR makes minor changes in the docs to avoid such potential confusions.


^ 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.

Make the doc around CeleryKubernetesExecutor clearer.
@XD-DENG XD-DENG added this to the Airflow 2.0.1 milestone Dec 16, 2020
@boring-cyborg boring-cyborg bot added the area:Scheduler including HA (high availability) scheduler label Dec 16, 2020
@XD-DENG XD-DENG removed the area:Scheduler including HA (high availability) scheduler label Dec 16, 2020
@XD-DENG XD-DENG requested review from kaxil, ashb and turbaszek December 16, 2020 20:26
@github-actions
Copy link

The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest master at your convenience, or amend the last commit of the PR, and push it with --force-with-lease.

@github-actions github-actions bot added the full tests needed We need to run full set of tests for this PR to merge label Dec 16, 2020
@XD-DENG XD-DENG merged commit 2491a93 into apache:master Dec 16, 2020
kaxil pushed a commit that referenced this pull request Jan 21, 2021
Make the doc around CeleryKubernetesExecutor clearer.

(cherry picked from commit 2491a93)
@XD-DENG XD-DENG deleted the improve-k8s-celery-executor-doc branch March 26, 2021 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
full tests needed We need to run full set of tests for this PR to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants