Skip to content

fix(examples): Change FastAPI to lowercase in example #277

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.

Sign up for GitHub

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
nurof3n merged 1 commit into from
Apr 7, 2026
Merged

fix(examples): Change FastAPI to lowercase in example #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions ...er-python3.12-FastAPI-0.121.3-stable.yaml → ...er-python3.12-fastapi-0.121.3-stable.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
name: examples/httpserver-python3.12-FastAPI-0.121.3 (stable)
name: examples/httpserver-python3.12-fastapi-0.121.3 (stable)

on:
workflow_dispatch:
push:
branches: [ main ]
paths:
- '.github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-stable.yaml'
- 'httpserver-python3.12-FastAPI-0.121.3/**'
- '!httpserver-python3.12-FastAPI-0.121.3/README.md'
- '.github/workflows/example-httpserver-python3.12-fastapi-0.121.3-stable.yaml'
- 'httpserver-python3.12-fastapi-0.121.3/**'
- '!httpserver-python3.12-fastapi-0.121.3/README.md'
pull_request:
types: [ opened, synchronize, reopened ]
branches: [ main ]
paths:
- '.github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-stable.yaml'
- 'httpserver-python3.12-FastAPI-0.121.3/**'
- '!httpserver-python3.12-FastAPI-0.121.3/README.md'
- '.github/workflows/example-httpserver-python3.12-fastapi-0.121.3-stable.yaml'
- 'httpserver-python3.12-fastapi-0.121.3/**'
- '!httpserver-python3.12-fastapi-0.121.3/README.md'
schedule:
- cron: '0 2 * * 1-5'

Expand Down Expand Up @@ -43,7 +43,7 @@ jobs:
with:
run: |
set -xe;
cd httpserver-python3.12-FastAPI-0.121.3;
cd httpserver-python3.12-fastapi-0.121.3;
kraft cloud deploy \
--no-start \
--name fastapi-${GITHUB_RUN_ID} \
Expand Down
16 changes: 8 additions & 8 deletions ...r-python3.12-FastAPI-0.121.3-staging.yaml → ...r-python3.12-fastapi-0.121.3-staging.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
name: examples/httpserver-python3.12-FastAPI-0.121.3 (staging)
name: examples/httpserver-python3.12-fastapi-0.121.3 (staging)

on:
workflow_dispatch:
push:
branches: [ main ]
paths:
- '.github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-staging.yaml'
- 'httpserver-python3.12-FastAPI-0.121.3/**'
- '!httpserver-python3.12-FastAPI-0.121.3/README.md'
- '.github/workflows/example-httpserver-python3.12-fastapi-0.121.3-staging.yaml'
- 'httpserver-python3.12-fastapi-0.121.3/**'
- '!httpserver-python3.12-fastapi-0.121.3/README.md'
pull_request:
types: [ opened, synchronize, reopened ]
branches: [ main ]
paths:
- '.github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-staging.yaml'
- 'httpserver-python3.12-FastAPI-0.121.3/**'
- '!httpserver-python3.12-FastAPI-0.121.3/README.md'
- '.github/workflows/example-httpserver-python3.12-fastapi-0.121.3-staging.yaml'
- 'httpserver-python3.12-fastapi-0.121.3/**'
- '!httpserver-python3.12-fastapi-0.121.3/README.md'
schedule:
- cron: '0 15 * * 1-5'

Expand Down Expand Up @@ -43,7 +43,7 @@ jobs:
with:
run: |
set -xe;
cd httpserver-python3.12-FastAPI-0.121.3;
cd httpserver-python3.12-fastapi-0.121.3;
kraft cloud deploy \
--no-start \
--name fastapi-${GITHUB_RUN_ID} \
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Example | Unikraft Cloud <br /> `stable` | Unikraft Cloud <br /> `staging` |
| [`httpserver-php8.2`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-php8.2) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-php8.2-stable.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-php8.2-stable.yaml) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-php8.2-staging.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-php8.2-staging.yaml) |
| [`httpserver-prisma-expressjs4.19-node18`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-prisma-expressjs4.19-node18) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-prisma-expressjs4.19-node18-stable.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-prisma-expressjs4.19-node18-stable.yaml) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-prisma-expressjs4.19-node18-staging.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-prisma-expressjs4.19-node18-staging.yaml) |
| [`httpserver-python3.12`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-python3.12) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-stable.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-stable.yaml) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-staging.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-staging.yaml) |
| [`httpserver-python3.12-FastAPI-0.121.3`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-python3.12-FastAPI-0.121.3) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-FastAPI-0.121.3-stable.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-FastAPI-0.121.3-stable.yaml) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-FastAPI-0.121.3-staging.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-FastAPI-0.121.3-staging.yaml) |
| [`httpserver-python3.12-fastapi-0.121.3`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-python3.12-fastapi-0.121.3) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-fastapi-0.121.3-stable.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-fastapi-0.121.3-stable.yaml) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-fastapi-0.121.3-staging.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-fastapi-0.121.3-staging.yaml) |
| [`httpserver-python3.12-django5.0`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-python3.12-django5.0) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-django5.0-stable.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-django5.0-stable.yaml) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-django5.0-staging.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-django5.0-staging.yaml) |
| [`httpserver-python3.12-flask3.0`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-python3.12-flask3.0) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-flask3.0-stable.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-flask3.0-stable.yaml) | [![](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-flask3.0-staging.yaml/badge.svg)](https://github.com/unikraft-cloud/examples/actions/workflows/example-httpserver-python3.12-flask3.0-staging.yaml) |
| [`httpserver-python3.12-flask3.0-sqlite`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-python3.12-flask3.0-sqlite) | | |
Expand Down
0 ...ver-python3.12-FastAPI-0.121.3/Dockerfile → ...ver-python3.12-fastapi-0.121.3/Dockerfile
View file
Open in desktop
File renamed without changes.
0 ...rver-python3.12-FastAPI-0.121.3/Kraftfile → ...rver-python3.12-fastapi-0.121.3/Kraftfile
View file
Open in desktop
File renamed without changes.
14 changes: 7 additions & 7 deletions ...rver-python3.12-FastAPI-0.121.3/README.md → ...rver-python3.12-fastapi-0.121.3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ To run this example, follow these steps:
1. Install the CLI and a container runtime engine, for example [Docker](https://docs.docker.com/engine/install/).
Use the [unikraft CLI](https://unikraft.com/docs/cli/unikraft) or the legacy [kraft CLI](https://unikraft.org/docs/cli/install).

1. Clone the [`examples` repository](https://github.com/unikraft-cloud/examples) and `cd` into the `examples/httpserver-python3.12-FastAPI-0.121.3/` directory:
1. Clone the [`examples` repository](https://github.com/unikraft-cloud/examples) and `cd` into the `examples/httpserver-python3.12-fastapi-0.121.3/` directory:

```bash
git clone https://github.com/unikraft-cloud/examples
cd examples/httpserver-python3.12-FastAPI-0.121.3/
cd examples/httpserver-python3.12-fastapi-0.121.3/
```

Make sure to log into Unikraft Cloud and pick a [metro](https://unikraft.com/docs/platform/metros) close to you.
Expand All @@ -32,8 +32,8 @@ export UKC_METRO=fra
When done, invoke the following command to deploy this app on Unikraft Cloud:

```bash title="unikraft"
unikraft build . --output <my-org>/httpserver-python3.12-FastAPI-0.121.3:latest
unikraft run --metro=fra -p 443:8080/tls+http -m 512M <my-org>/httpserver-python3.12-FastAPI-0.121.3:latest
unikraft build . --output <my-org>/httpserver-python3.12-fastapi-0.121.3:latest
unikraft run --metro=fra -p 443:8080/tls+http -m 512M <my-org>/httpserver-python3.12-fastapi-0.121.3:latest
```

or
Expand Down Expand Up @@ -138,13 +138,13 @@ The following options are available for customizing the app:
It's used to install dependencies for Python apps.
`pip` uses the `requirements.txt` file to list required dependencies (with versions).

The [`httpserver-python3.12-FastAPI-0.121.3`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-python3.12-FastAPI-0.121.3) guide details the use of `pip` to deploy an app using the [`FastAPI`](https://fastapi.tiangolo.com/) framework on Unikraft Cloud.
The [`httpserver-python3.12-fastapi-0.121.3`](https://github.com/unikraft-cloud/examples/tree/main/httpserver-python3.12-fastapi-0.121.3) guide details the use of `pip` to deploy an app using the [`FastAPI`](https://fastapi.tiangolo.com/) framework on Unikraft Cloud.

Run the command below to deploy the app on Unikraft Cloud:

```bash title="unikraft"
unikraft build . --output <my-org>/httpserver-python3.12-FastAPI-0.121.3:latest
unikraft run --metro=fra -p 443:8080/tls+http -m 512M <my-org>/httpserver-python3.12-FastAPI-0.121.3:latest
unikraft build . --output <my-org>/httpserver-python3.12-fastapi-0.121.3:latest
unikraft run --metro=fra -p 443:8080/tls+http -m 512M <my-org>/httpserver-python3.12-fastapi-0.121.3:latest
```

or
Expand Down
0 ...thon3.12-FastAPI-0.121.3/requirements.txt → ...thon3.12-fastapi-0.121.3/requirements.txt
View file
Open in desktop
File renamed without changes.
0 ...rver-python3.12-FastAPI-0.121.3/server.py → ...rver-python3.12-fastapi-0.121.3/server.py
View file
Open in desktop
File renamed without changes.
Loading