Add fastapi init profile and fastapi-framework extension #692
Conversation
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
jdkandersson
reviewed
Sep 3, 2024
|
Hi @tigarmo can you have a look at this PR? Thanks! |
jdkandersson
approved these changes
Sep 5, 2024
1 task
Co-authored-by: Tiago Nobrega <tiago.nobrega@canonical.com>
lengau
reviewed
Sep 16, 2024
lengau
approved these changes
Sep 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR implements the spec ISD160 - 12-Factor FastAPI Support" for rockcraft.
For that, a new init profile called "fastapi-framework" and a new fastapi extension, called "fastapi-framework" are needed. These additions are similar to the flask and django init profiles and extensions, with several differences. Some of the main differences are:
FastAPI and starlette supported.
The ASGI entrypoint location can be in serveral places (and it is ASGI instead of WSGI).
No dependency on gunicorn. FastAPI works with uvicorn without a configuration file.
No statsd.
Ubuntu 24.04 by default (supported bases 24.04 and bare).
All current extensions (go, django, flask and now fastapi), have similarities (at the end they extend/change the rockcraft.yaml file), but also many subtle different details, like how they service command is overridden, extra tools or frameworks, what can be overridden and how, extra env variables (only Go).... As so, I have decided to not try to use a common base class for all of them (allowing them to easily evolve independently without a coupled inheritance structure). This is a tradeoff, as code is similar between frameworks. This is open for discussion.