-
Notifications
You must be signed in to change notification settings - Fork 16.6k
Add gunicorn support for API server with rolling worker restarts #60940
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| Add gunicorn support for API server with zero-downtime worker recycling | ||
|
|
||
| The API server now supports gunicorn as an alternative server with rolling worker restarts | ||
| to prevent memory accumulation in long-running processes. | ||
|
|
||
| **Key Benefits:** | ||
|
|
||
| * **Rolling worker restarts**: New workers spawn and pass health checks before old workers | ||
| are killed, ensuring zero downtime during worker recycling. | ||
|
|
||
| * **Memory sharing**: Gunicorn uses preload + fork, so workers share memory via | ||
| copy-on-write. This significantly reduces total memory usage compared to uvicorn's | ||
| multiprocess mode where each worker loads everything independently. | ||
|
|
||
| * **Correct FIFO signal handling**: Gunicorn's SIGTTOU kills the oldest worker (FIFO), | ||
| not the newest (LIFO), which is correct for rolling restarts. | ||
|
|
||
| **Configuration:** | ||
|
|
||
| .. code-block:: ini | ||
|
|
||
| [api] | ||
| # Use gunicorn instead of uvicorn | ||
| server_type = gunicorn | ||
|
|
||
| # Enable rolling worker restarts every 12 hours | ||
| worker_refresh_interval = 43200 | ||
|
|
||
| # Restart workers one at a time | ||
| worker_refresh_batch_size = 1 | ||
|
|
||
| Or via environment variables: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| export AIRFLOW__API__SERVER_TYPE=gunicorn | ||
| export AIRFLOW__API__WORKER_REFRESH_INTERVAL=43200 | ||
|
|
||
| **Requirements:** | ||
|
|
||
| Install the gunicorn extra: ``pip install 'apache-airflow-core[gunicorn]'`` | ||
|
|
||
| **Note on uvicorn (default):** | ||
|
|
||
| The default uvicorn mode does not support rolling worker restarts because: | ||
|
|
||
| 1. With workers=1, there is no master process to send signals to | ||
| 2. uvicorn's SIGTTOU kills the newest worker (LIFO), defeating rolling restart purposes | ||
| 3. Each uvicorn worker loads everything independently with no memory sharing | ||
|
|
||
| If you need worker recycling or memory-efficient multi-worker deployment, use gunicorn. | ||
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.