THIS IS EXPERIMENTAL DO NOT USE IN PRODUCTION ENVIRONMENTS
Automatically build specialised Lupine unikernels from Docker images.
- Firecracker
- Python 3
- Linux host with KVM
- Make + GCC
Setup the Python environment how you would normally using the Pipfile, install the dev dependencies if you wish to run the benchmarks.
The first step to building your Lupine unikernel is building a manifest, for best results use an Alpine based Docker image.
Running scripts/host/build_manifest.py will build a manifest from a given Docker image and populates manifestout/ with a manifest and tarball of the rootfs.
$ python scripts/host/build_manifest.py --help
usage: build_manifest.py [-h] [--output OUTPUT] [--skip_fs_dump] [--no_kml] [--envs ENVS [ENVS ...]] [--cmd CMD] docker_image [docker_tag]
positional arguments:
docker_image
docker_tag
optional arguments:
-h, --help show this help message and exit
--output OUTPUT
--skip_fs_dump just remake the manifest
--no_kml disable KML in the Lupine image
--envs ENVS [ENVS ...]
environment variables to add to the manifest
--cmd CMD comma seperated list of args to append to the command
Run from the Lupine root directoryFor example:
$ python scripts/host/build_manifest.py nginx alpine --output nginxWill create nginx.json and nginx.tar in manifestout.
From the manifest you can build a Lupine image, a kernel build and ext4 filesystem in kernelbuild/ and rootfsbuild.
$ python scripts/host/build_image.py --help
usage: build_image.py [-h] [--name NAME] [--kernel] [--filesystem] manifest
positional arguments:
manifest
optional arguments:
-h, --help show this help message and exit
--kernel build the kernel
--filesystem create the filesystem
Run from the Lupine root directoryFor example:
$ python scripts/host/build_image.py manifestout/nginx.jsonWill build kernelbuild/nginx as a vmlinux and rootfsbuild/nginx.ext4.
Images are run in Firecracker with a Python handler script.
$ python scripts/host/host.py --help
usage: host.py [-h] [--ip IP] [--port PORT] [--strace] lupine
positional arguments:
lupine Built image to run
optional arguments:
-h, --help show this help message and exit
--ip IP, -a IP
--port PORT, -p PORT
--strace, -s debug to build minimal manifest
Run from Lupine root directoryFor example:
$ python scripts/host/host.py nginxWill start the NGINX webserver on 192.168.100.2.
When you want to shut down webserver, hit enter in the Python output.
Run you image with --strace to perform a trace of the application that will reduce the manifest. The manifest is expected to be in manifestout/<APP_NAME>.json
For example:
$ python scripts/host/host.py nginx --straceA which point, use the application as you would normally and when you are finished hit enter in the Python output.
This will build a specialised manifest that can be used to rebuild the image, for example:
$ python scripts/host/build_image.py manifestout/nginx.jsonRun make docker-bench to build the benchmark Docker images.
There is a series of scripts in scripts/benchmark that will measure the performance of the Lupine unikernels compared to Docker.
$ scripts/benchmark/performance/node.shWill measure performance of a Node.js application.