To begin using Unikraft you can use the
command-line utility kraft, which is a companion tool used for
defining, configuring, building, and running Unikraft applications.
With kraft you can seamlessly create a build environment for your
unikernel and painlessly manage dependencies for its build.
The kraft tool and Unikraft build system have a number of package
requirements; please run the following command (on apt-get-based systems) to
install the requirements:
apt-get install -y --no-install-recommends build-essential libncurses-dev libyaml-dev flex git wget socat bison unzip uuid-runtime;
Note: Ubuntu 20.04 users may suffer from issue #29 due to this bug of socat-1.7.3.3. If you are using Ubuntu 20.04, please make sure to compile and install the latest version of socat retrieved from this page.
To install kraft simply run:
pip3 install git+https://github.com/unikraft/kraft.git@staging
You can then type kraft to see its help menu
The simplest way to get the sources for, build and run an application is by running the following commands:
kraft list update
kraft up -t helloworld@staging ./my-first-unikernel
At present, Unikraft and kraft support the following applications:
- C "hello world" (
helloworld); - C "http reply" (
httpreply); - C++ "hello world" (
helloworld-cpp); - Golang (
helloworld-go); - Python 3 (
python3); - Micropython (
micropython); - Ruby (
ruby); - Lua (
lua); - Click Modular Router (
click); - JavaScript (Duktape) (
duktape); - Web Assembly Micro Runtime (WAMR) (
wamr); - Redis (
redis); - Nginx (
nginx); - SQLite (
sqlite);
For more information about that command type kraft up -h. For more information
about kraft type kraft -h or read the documentation at
Unikraft's website. If you find any problems please
fill out an issue. Thank
you!
Please refer to the README.md
as well as the documentation in the doc/
subdirectory of the main Unikraft repository.