Django HTTP Server
This guide explains how to create and deploy a Python Django web app. To run this example, follow these steps:
-
Install the CLI. Use the unikraft CLI or the legacy kraft CLI. You need a BuildKit builder. The easiest way to get one is via Docker. Alternatively, you can also directly set up and use BuildKit, see the quick start.
The unikraft CLI is the current standard, while kraft is the legacy version. Choose one of the CLIs below and only run the commands associated with it for the rest of this guide.
-
Clone the
examplesrepository andcdinto theexamples/httpserver-python3.12-django5.0/directory:Code
Make sure to log into Unikraft Cloud and pick a metro close to you.
This guide uses fra (Frankfurt, 🇩🇪):
When done, invoke the following command to deploy this app on Unikraft Cloud:
The output shows the instance address and other details:
In this case, the instance name is httpserver-python312-django50-vt56c and the address is https://dawn-sound-n5wrkxi2.fra.unikraft.app.
They're different for each run.
Use curl to query the Unikraft Cloud instance of the Django web app server:
Code
Code
Or point a browser at the address and/or its /admin area.
You can set the username and password in the Dockerfile (more on this file later) to unikraft/unikraft.
The example sets ALLOWED_HOSTS to * and runs in debug mode. For a production site, ensure you read the recommended deployment guides of the official Django project.
You can list information about the instance by running:
When done, you can remove the instance:
Customize your app
To customize the app, update the files in the repository, listed below:
main.py: the entry point for the appKraftfile: the Unikraft Cloud specificationDockerfile: the Docker-specified app filesystem
Lines in the Kraftfile have the following roles:
-
spec: v0.7: The currentKraftfilespecification version is0.7. -
runtime: base-compat:latest: The runtime kernel to use is the base compatibility kernel. -
rootfs: Build the app root filesystem.source: ./Dockerfilemeans the filesystem is built using theDockerfile.format: erofsmeans the filesystem type is EROFS. -
cmd: ["/usr/bin/python3", "/app/main.py"]: Use this as the starting command of the instance.
Lines in the Dockerfile have the following roles:
FROM scratch: Build the filesystem from thescratchcontainer image, to create a base image.
The following options are available for customizing the app:
-
If you only update the implementation in the
main.pysource file, you don't need to make any other changes. -
If you create any new source files, copy them into the app filesystem by using the
COPYcommand in theDockerfile. -
More extensive changes may require extending the
Dockerfile(seeDockerfilesyntax reference). This includes the use of Python frameworks and the use ofpip, as shown in the next section.
Using pip
pip is a package manager for Python.
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-flask3.0 guide details the use of pip to deploy an app using the Flask framework on Unikraft Cloud.
Run the command below to deploy the app on Unikraft Cloud:
Differences from the Django app are also the steps required to create an pip-based app:
-
Add the
requirements.txtfile used bypip. -
Add framework-specific source files. In this case, this means the
server.pyfile. -
Update the
Dockerfileto:3.1.
COPYthe local files.3.2.
RUNthepip3 installcommand to install dependencies.3.3.
COPYof the resulting and required files (/usr/local/lib/python3.12andserver.py) in the app filesystem, using thescratchcontainer.
The following lists the files:
The requirements.txt file lists the flask dependency.
The Kraftfile is the same one used for Django.
For Dockerfile newly added lines have the following roles:
-
FROM python:3.12-bookworm AS base: Use the base image of thepython:3.12-bookwormcontainer. This provides thepip3binary and other Python-related components. Name the current imagebase. -
WORKDIR /app: Use/appas working directory. All other commands in theDockerfilerun inside this directory. -
COPY requirements.txt /app: Copy the package configuration file to the Docker filesystem. -
RUN pip3 install ...: Installpipcomponents listed inrequirements.txt. -
COPY --from=base ...: Copy generated Python files in the newbaseimage in thescratch-based image.
Similar actions apply to other pip3-based apps.
Learn more
Use the --help option for detailed information on using Unikraft Cloud:
Or visit the CLI Reference or the legacy CLI Reference.