feat: add configurable celery beat schedule filename
Fixes #28530
[!IMPORTANT]
- Make sure you have read our contribution guidelines
- Ensure there is an associated issue and you have been assigned to it
- Use the correct syntax to link this PR:
Fixes #<issue number>.
Summary
This change adds support for customizing the Celery Beat schedule file path via the CELERY_BEAT_SCHEDULE_FILENAME environment variable. This is useful in Kubernetes environments where the root filesystem is read-only, as Celery Beat cannot create its default schedule file. By allowing the schedule file location to be configured (e.g., /tmp/celerybeat-schedule.db), deployments can avoid write-permission issues without modifying the application code.
No additional dependencies are introduced by this change.
You can verify the correctness of this change in the official Celery documentation. Celery Beat supports customizing the schedule database path using the --schedule (-s) option, as described here:
https://docs.celeryq.dev/en/stable/reference/cli.html#beat
According to the documentation, the --schedule option allows specifying an alternative path for the schedule file instead of the default celerybeat-schedule. This confirms that providing a custom schedule file path (e.g., via the CELERY_BEAT_SCHEDULE_FILENAME environment variable) is an intended and supported behavior in Celery.
Screenshots
| Before | After |
|---|---|
Checklist
- [x] This change requires a documentation update, included: Dify Document
- [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
- [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
- [x] I've updated the documentation accordingly.
- [x] I ran
dev/reformat(backend) andcd web && npx lint-staged(frontend) to appease the lint gods
Summary of Changes
Hello @potix2, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the application's deployment flexibility by allowing the Celery Beat schedule file path to be configured via an environment variable. This is particularly beneficial for containerized deployments, such as those in Kubernetes, where default file locations might not be writable, ensuring the proper functioning of scheduled tasks without requiring modifications to the application's core code.
Highlights
- Configurable Celery Beat Schedule Filename: Introduced support for customizing the Celery Beat schedule file path using the
CELERY_BEAT_SCHEDULE_FILENAMEenvironment variable. - Kubernetes Compatibility: This change specifically addresses issues in Kubernetes environments where the root filesystem is often read-only, preventing Celery Beat from creating its default schedule file.
- Leverages Celery's
--scheduleoption: The implementation utilizes Celery's built-in--schedulecommand-line option, allowing the schedule file location to be specified dynamically.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
/gemini review