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

docs: gunicorn with uvicorn workers #3973

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

Conversation

YorkSu
Copy link
Contributor

@YorkSu YorkSu commented Jan 25, 2025

Description

  • Add a page in the Deployments section for using Uvicorn workers with Gunicorn to deploy ASGI applications.

NOTE

The Gunicorn+Uvicorn pattern is considered legacy for ASGI deployments since Uvicorn 0.30.0+ includes native worker management.

References:

Closes

Part of #2609

@YorkSu YorkSu requested review from a team as code owners January 25, 2025 06:03
@github-actions github-actions bot added area/docs This PR involves changes to the documentation size: small type/docs pr/external Triage Required 🏥 This requires triage labels Jan 25, 2025
Copy link
Member

@provinzkraut provinzkraut left a comment

Choose a reason for hiding this comment

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

Don't think we should, as it's not really something I'd recommend anyway, and neither does uvicorn, since they've improved their own proc management.

@litestar-org/members @litestar-org/maintainers if you feel differently, please weigh in

@euri10
Copy link
Contributor

euri10 commented Jan 25, 2025

I wouldnt recommend it either, but then we need to update the issue linked so that efforts like this aren't made for nothing.

@provinzkraut
Copy link
Member

I wouldnt recommend it either, but then we need to update the issue linked so that efforts like this aren't made for nothing.

Good point. Done.

@YorkSu
Copy link
Contributor Author

YorkSu commented Jan 26, 2025

I wouldn't recommend it either.

Considering that users might search for the keyword Gunicorn, would you consider adding a brief description to the manually-with-asgi-server section?

Since some developers might not be aware that the latest Uvicorn versions no longer need to deploy with Gunicorn for multi-workers, providing it could be helpful.

Copy link

codecov bot commented Jan 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.34%. Comparing base (e5340cf) to head (9488851).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3973   +/-   ##
=======================================
  Coverage   98.34%   98.34%           
=======================================
  Files         347      347           
  Lines       15756    15756           
  Branches     1741     1741           
=======================================
  Hits        15496    15496           
  Misses        124      124           
  Partials      136      136           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@YorkSu YorkSu force-pushed the docs/gunicorn-with-uvicorn-workers branch from cfe4af2 to 9488851 Compare January 26, 2025 01:54
Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3973

@provinzkraut
Copy link
Member

I wouldn't recommend it either.

Considering that users might search for the keyword Gunicorn, would you consider adding a brief description to the manually-with-asgi-server section?

Since some developers might not be aware that the latest Uvicorn versions no longer need to deploy with Gunicorn for multi-workers, providing it could be helpful.

I think it should be just that notice

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This PR involves changes to the documentation pr/external size: small Triage Required 🏥 This requires triage type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants