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

Add support for custom celery configs #45038

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

arorasachin9
Copy link

@arorasachin9 arorasachin9 commented Dec 18, 2024

closes: #45037

Description:
Currently Airflow support limited celery options only. This PR adds the support for the additional celery config for celery workers.

  1. Changes are completely backward compatible
  2. No test cases found for these changes
  3. If the config is not available then default value of {} is taken which will be same as earlier only
  4. If config is available then it will be added to the celery config and applied to celery workers.

Copy link

boring-cyborg bot commented Dec 18, 2024

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 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 Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment 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 for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • 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: [email protected]
    Slack: https://s.apache.org/airflow-slack

Copy link
Contributor

@jscheffl jscheffl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR - the contribution looks really small and is efficient. Thanks for taking care for the backwards compatibility.

I assume the fallback handling in default_celery.py:72is not needed if the config entry is correctly registered as a default in providers/src/airflow/providers/celery/provider.yaml - There all configs for the provider should be registered. This also would add missing documentation.

Copy link
Member

@jedcunningham jedcunningham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add a test for this?

chart/values.yaml Outdated Show resolved Hide resolved
@arorasachin9
Copy link
Author

Addressed the comments. CI is failing not able to debug why CI pipeline is failing.

@jscheffl
Copy link
Contributor

jscheffl commented Dec 18, 2024

Except some minor comment I think it is good, let me check what is broken on CI. Nothing related to your code.
Ignore that it is "red" atm, will be better once you push the next change on the PR.

Then I think... LGTM!

@eladkal eladkal removed the area:helm-chart Airflow Helm Chart label Dec 19, 2024
@eladkal eladkal changed the title #45037: Support for additional celery config directly from airflow.cfg Add support for custom celery configs Dec 19, 2024
@jscheffl jscheffl force-pushed the feature/airflow-45037 branch from 2c56333 to 382d45e Compare December 22, 2024 17:13
@jscheffl
Copy link
Contributor

Somthing is wrong with this PR and CI - I don't see the reason but I am very sure it is not related to the changes. I am on it...

version_added: ~
type: string
example: ~
default: "{}"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I also did not know but defaults seem to be Format-String formatted and the string "{}" is an invalid sequence. So to effectively have an {} as default we need to use {{}} here to quote the brackets.

Suggested change
default: "{}"
default: "{{}}"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay ... interesting, this also resolves the CI problem - it seems the constrains also can not be built as the templating fails there. I did a PR with the fixes applied as test and this is turning green: #45160
As with the other proposal a check is being made that the settings are a dict, you can even lave an empty string as default...

Suggested change
default: "{}"
default: ""

@@ -85,6 +87,7 @@ def _broker_supports_visibility_timeout(url):
),
"worker_concurrency": conf.getint("celery", "WORKER_CONCURRENCY", fallback=16),
"worker_enable_remote_control": conf.getboolean("celery", "worker_enable_remote_control", fallback=True),
**extra_celery_config,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As CI did not get to this stage (yet) as failing earlier, there will be a problem reported by mypy for providers like:

providers/src/airflow/providers/celery/executors/default_celery.py:72: error:
Incompatible types in assignment (expression has type
"Union[dict[Any, Any], list[Any], str, int, float, None]", variable has type
"dict[Any, Any]")  [assignment]
    extra_celery_config: dict = conf.getjson("celery", "extra_celery_confi...
                                ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~...
Found 1 error in 1 file (checked 1 source file)
Error 1 returned

As the JSON result can be other values than a dict (irrespective of the type declaration above, you need to use:

Suggested change
**extra_celery_config,
**(extra_celery_config if isinstance(extra_celery_config, dict) else {}),

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support of custom celery configs
5 participants