A simple demonstration of how a django-based website can be set up for local development with microk8s

Last update: Oct 22, 2022

Related tags

Overview

Django with MicroK8s

Start Building Your Project

This project provides a Django web app running as a single node Kubernetes cluster in microk8s. It is meant to make it as easy as possible to begin building a project with a minimum of initial configuration.

This is both a reference and an actual github template that can be used to quickly start development. After installing prerequisites and downloading this repository, only one command is needed to have a working, browsable application.

Provided Tools

A running Django server
PostgreSQL database
Redis Cache
Ingress configuration to access the web server from your local machine
Automatic database migration on start
Automatic web-server reloading on code changes
Demonstration of Kubernetes Secrets integration
Pre-commit hooks with style checking and linting
Continuous Integration via Github Actions
A shell script with useful commands to interact with the system

Prerequisites

You'll need to install the following software:

Docker >= v20.10.0
Microk8s >= v1.21
Pre-commit >= 2.12.1

Note that the system has only been tested on Ubuntu 18+, but should theoretically work for any host OS on which Microk8s and docker can be installed.

Initial Operation

Install pre-requisites.

Download the repository:

git clone [email protected]:bluemoo/django-with-microk8s.git

Install pre-commit hooks:
```
pre-commit install
```

Start Microk8s and enable required add-ons:

microk8s.start
microk8s enable helm3 dns storage registry host-access ingress

Start the system:
```
./dev.sh start
```
Check for successful startup with:
```
./dev.sh status
```
Navigate to http://localhost:8000 and you should see Django tell you it was installed successfully!

Example System Start

$ microk8s.start
Started.

$ microk8s enable helm3 dns storage registry host-access ingress
Enabling Helm 3
Fetching helm version v3.5.0.
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 11.7M  100 11.7M    0     0  8430k      0  0:00:01  0:00:01 --:--:-- 8430k
Helm 3 is enabled
Addon dns is already enabled.
Addon storage is already enabled.
Addon registry is already enabled.
Addon host-access is already enabled.
Addon ingress is already enabled.


$ ./dev.sh start
Checking microk8s configuration
Build image
Sending build context to Docker daemon  7.146MB
<-- Snipped Steps -->
Successfully built aeb2100b9b07
Successfully tagged server:development-server
Pushing image to registry
The push refers to repository [localhost:32000/server]
<-- Snip Pushing Image -->
Setting up Secrets
<-- Snip -->
Installing database
<-- Snip -->
Wait for database to be ready
pod/postgres-statefulset-0 condition met
Installing server
<-- Snip -->
Configuring Ingress
configmap/nginx-ingress-tcp-microk8s-conf unchanged
daemonset.apps/nginx-ingress-microk8s-controller unchanged

$ ./dev.sh status
NAME                                  READY   STATUS      RESTARTS   AGE
development-server-7f5c56ff54-wmgf5   1/1     Running     0          9s
migration-job-gqd65                   0/1     Completed   0          13s
postgres-statefulset-0                1/1     Running     0          18s
redis-statefulset-0                   1/1     Running     0          9s

$ wget http://localhost:8000/
2021-05-11 20:07:00 (84,3 MB/s) - ‘index.html’ saved [10697/10697]

$ grep "The install worked successfully! Congratulations!" index.html 
        <title>The install worked successfully! Congratulations!</title>
        <h1>The install worked successfully! Congratulations!</h1>

$ ./dev.sh test
.System check identified no issues (0 silenced).
..
----------------------------------------------------------------------
Ran 3 tests in 0.001s

OK

Development Workflows

dev.sh

The project comes with a shell script dev.sh that contains helpful commands to interact with the running system. In particular, it has options to install/uninstall the system, run django management commands, and run django tests. For a full set of options, simply type: ./dev.sh help

Hot code reloading

The development server mounts files directly from your file system, so any changes to python files will be automatically noticed and result in the server automatically reloading the code:

$ ./dev.sh server-logs
10.1.97.1 - - [11/May/2021 18:33:12] "GET / HTTP/1.1" 200 -
10.1.97.1 - - [11/May/2021 18:33:12] "GET / HTTP/1.1" 200 -
 * Detected change in '/opt/project/server/appsecrets.py', reloading
 * Restarting with stat
Performing system checks...

System check identified no issues (0 silenced).

Django version 3.2.2, using settings 'settings'
Development server is running at http://0.0.0.0:8000/
Using the Werkzeug debugger (http://werkzeug.pocoo.org/)
Quit the server with CONTROL-C.

Thus, you can edit, save, and see your changes in your app very quickly.

Database migrations

As this is a development environment, migrations are automatically applied on system start up, so you'll have an empty django database schema from the beginning. You can perform all other database interactions as you would normally via the Django manage command provided by dev.sh:

$ ./dev.sh manage makemigrations
No changes detected

$ ./dev.sh manage migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, sessions
Running migrations:
  No migrations to apply.

Testing

While django tests can be run via the manage command, the dev.sh file provides a small shortcut, allowing you to simply use ./dev.sh test. You can also pass one or more test labels:

$ ./dev.sh test
...
----------------------------------------------------------------------
Ran 3 tests in 0.001s

OK
System check identified no issues (0 silenced).

$ ./dev.sh test tests.test_appsecrets.AppSecretsIntegrationTest
.
----------------------------------------------------------------------
System check identified no issues (0 silenced).
Ran 1 test in 0.000s

OK

Next steps

This development environment should server you well until you're ready to actually deploy your app to production. However, if you're new to Django, you can easily pick up the tutorial from Creating the Polls app. Just remember that instead of typing python manage.py startapp polls you should use ./dev.sh manage startapp polls instead. Good luck!

Notes

If you want to run docker as non-root user then you need to add it to the docker group. https://stackoverflow.com/questions/48957195/how-to-fix-docker-got-permission-denied-issue

A simple demonstration of how a django-based website can be set up for local development with microk8s

Related tags

Overview

Django with MicroK8s

Start Building Your Project

Provided Tools

Prerequisites

Initial Operation

Example System Start

Development Workflows

dev.sh

Hot code reloading

Database migrations

Testing

Next steps

Notes

Owner

Noah Jacobson

A Django app to accept payments from various payment processors via Pluggable backends.

Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly.

Indonesia's negative news detection using gaussian naive bayes with Django+Scikir Learn

Modular search for Django

Python port of Google's libphonenumber

GameStop clone with Django

Integarting Celery with Django to asynchronous tasks 📃

The little ASGI framework that shines. 🌟

Full control of form rendering in the templates.

Django Audit is a simple Django app that tracks and logs requests to your application.

Django CacheMiddleware has a multi-threading issue with pylibmc

Sistema administrador de contranas desarrollador en Django

Improved Django model inheritance with automatic downcasting

wagtail_tenants is a Django/Wagtail app to provide multitenancy to your wagtail project.

Imparare Django ricreando un sito facsimile a quello Flask

Django URL Shortener is a Django app to to include URL Shortening feature in your Django Project

Django React Project Setup

This website serves as an online database (hosted via SQLLite) for fictional businesses in the area to store contact information (name, email, phone number, etc.) for fictional customers.

Alt1-compatible widget host for RuneScape 3

A Django Webapp performing CRUD operations on Library Database.