From 2a90d7dfdd34959037814397ffa7eb2aff029f17 Mon Sep 17 00:00:00 2001 From: Daniel Vallance Date: Tue, 7 Apr 2026 12:11:59 +0100 Subject: [PATCH] fix(examples): Change FastAPI to lowercase in example The repository name must be lowercase for the commands in the example to work Closes: #274 --- ...erver-python3.12-fastapi-0.121.3-stable.yaml} | 16 ++++++++-------- ...rver-python3.12-fastapi-0.121.3-staging.yaml} | 16 ++++++++-------- README.md | 2 +- .../Dockerfile | 0 .../Kraftfile | 0 .../README.md | 14 +++++++------- .../requirements.txt | 0 .../server.py | 0 8 files changed, 24 insertions(+), 24 deletions(-) rename .github/workflows/{example-httpserver-python3.12-FastAPI-0.121.3-stable.yaml => example-httpserver-python3.12-fastapi-0.121.3-stable.yaml} (80%) rename .github/workflows/{example-httpserver-python3.12-FastAPI-0.121.3-staging.yaml => example-httpserver-python3.12-fastapi-0.121.3-staging.yaml} (80%) rename {httpserver-python3.12-FastAPI-0.121.3 => httpserver-python3.12-fastapi-0.121.3}/Dockerfile (100%) rename {httpserver-python3.12-FastAPI-0.121.3 => httpserver-python3.12-fastapi-0.121.3}/Kraftfile (100%) rename {httpserver-python3.12-FastAPI-0.121.3 => httpserver-python3.12-fastapi-0.121.3}/README.md (94%) rename {httpserver-python3.12-FastAPI-0.121.3 => httpserver-python3.12-fastapi-0.121.3}/requirements.txt (100%) rename {httpserver-python3.12-FastAPI-0.121.3 => httpserver-python3.12-fastapi-0.121.3}/server.py (100%) diff --git a/.github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-stable.yaml b/.github/workflows/example-httpserver-python3.12-fastapi-0.121.3-stable.yaml similarity index 80% rename from .github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-stable.yaml rename to .github/workflows/example-httpserver-python3.12-fastapi-0.121.3-stable.yaml index 8d37904b..180a89ef 100644 --- a/.github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-stable.yaml +++ b/.github/workflows/example-httpserver-python3.12-fastapi-0.121.3-stable.yaml @@ -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' @@ -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} \ diff --git a/.github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-staging.yaml b/.github/workflows/example-httpserver-python3.12-fastapi-0.121.3-staging.yaml similarity index 80% rename from .github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-staging.yaml rename to .github/workflows/example-httpserver-python3.12-fastapi-0.121.3-staging.yaml index 0c2259ea..d8ba9d52 100644 --- a/.github/workflows/example-httpserver-python3.12-FastAPI-0.121.3-staging.yaml +++ b/.github/workflows/example-httpserver-python3.12-fastapi-0.121.3-staging.yaml @@ -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' @@ -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} \ diff --git a/README.md b/README.md index 0e0c2b2c..dd05b8c7 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Example | Unikraft Cloud
`stable` | Unikraft Cloud
`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) | | | diff --git a/httpserver-python3.12-FastAPI-0.121.3/Dockerfile b/httpserver-python3.12-fastapi-0.121.3/Dockerfile similarity index 100% rename from httpserver-python3.12-FastAPI-0.121.3/Dockerfile rename to httpserver-python3.12-fastapi-0.121.3/Dockerfile diff --git a/httpserver-python3.12-FastAPI-0.121.3/Kraftfile b/httpserver-python3.12-fastapi-0.121.3/Kraftfile similarity index 100% rename from httpserver-python3.12-FastAPI-0.121.3/Kraftfile rename to httpserver-python3.12-fastapi-0.121.3/Kraftfile diff --git a/httpserver-python3.12-FastAPI-0.121.3/README.md b/httpserver-python3.12-fastapi-0.121.3/README.md similarity index 94% rename from httpserver-python3.12-FastAPI-0.121.3/README.md rename to httpserver-python3.12-fastapi-0.121.3/README.md index 09689663..b99bc17a 100644 --- a/httpserver-python3.12-FastAPI-0.121.3/README.md +++ b/httpserver-python3.12-fastapi-0.121.3/README.md @@ -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. @@ -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 /httpserver-python3.12-FastAPI-0.121.3:latest -unikraft run --metro=fra -p 443:8080/tls+http -m 512M /httpserver-python3.12-FastAPI-0.121.3:latest +unikraft build . --output /httpserver-python3.12-fastapi-0.121.3:latest +unikraft run --metro=fra -p 443:8080/tls+http -m 512M /httpserver-python3.12-fastapi-0.121.3:latest ``` or @@ -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 /httpserver-python3.12-FastAPI-0.121.3:latest -unikraft run --metro=fra -p 443:8080/tls+http -m 512M /httpserver-python3.12-FastAPI-0.121.3:latest +unikraft build . --output /httpserver-python3.12-fastapi-0.121.3:latest +unikraft run --metro=fra -p 443:8080/tls+http -m 512M /httpserver-python3.12-fastapi-0.121.3:latest ``` or diff --git a/httpserver-python3.12-FastAPI-0.121.3/requirements.txt b/httpserver-python3.12-fastapi-0.121.3/requirements.txt similarity index 100% rename from httpserver-python3.12-FastAPI-0.121.3/requirements.txt rename to httpserver-python3.12-fastapi-0.121.3/requirements.txt diff --git a/httpserver-python3.12-FastAPI-0.121.3/server.py b/httpserver-python3.12-fastapi-0.121.3/server.py similarity index 100% rename from httpserver-python3.12-FastAPI-0.121.3/server.py rename to httpserver-python3.12-fastapi-0.121.3/server.py