Skip to content

Quick Start

The simplest way to interact with the platform is to install the kraft tool:

curl -sSfL https://get.kraftkit.sh | sh

Once you have installed kraft, set the UKC (Unikraft Platform) access token you received during your on-boarding:

Terminal window
export UKC_TOKEN=token
export UKC_METRO=fra0 # set globally, or set via the cmd line as below

To take it out for a spin, run:

Terminal window
kraft cloud --metro fra0 deploy -p 443:8080 nginx:latest

This will create an NGINX web server instance in the fra0 metro, mapping port 443 (HTTPS) to port 8080 (NGINX’s default port). You should see output such as

Terminal window
[] Deployed successfully!
────────── name: nginx-6cfc4
────────── uuid: 62d1d6e9-0d45-4ced-ad2a-619718ba0344
───────── state: running
─────────── url: https://long-violet-92ka3gk7.fra0.kraft.host
───────── image: nginx@sha256:fb3e5fb1609ab4fd40d38ae12605d56fc0dc48aaa0ad4890ed7ba0b637af69f6
───── boot time: 16.65 ms
──────── memory: 128 MiB
─====== service: long-violet-92ka3gk7
── private fqdn: nginx-6cfc4.internal
──── private ip: 172.16.6.4
────────── args: /usr/bin/nginx -c /etc/nginx/nginx.conf

You can then test your app with your browser or via curl:

Terminal window
curl https://long-violet-92ka3gk7.fra0.kraft.host

Finally, you can kill your instance with:

Terminal window
kraft cloud instance rm nginx-6cfc4

For autoscale, please refer to the autoscale guide.

A Few Unikraft Cloud Concepts and Features

Just to make your initial Unikraft Cloud experience as smooth as possible it is important to note a few things about the platform.

Also, it’s worth being aware of the FAQs, where we document common issues users run into.

Next Steps

To help you kick-start your project we’ve put together a set of guides that will allow you to quickly deploy your favorite app. Also in that section you will find another set of guides showing how to use some of the platform’s features, including scale to 0 (on by default, but you can disable it), and autoscale.

If you’re interested in digging into even more details about how the platform works, you can further read the API documentation. Finally, see the CLI Reference for a full description of all kraft cloud commands.

Finally, any and all feedback is greatly appreciated. Happy Krafting! ⚒️🚀