This guide explains how to create and deploy a simple Elixir-based HTTP web server. To run this example, follow these steps:

1. 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.

   Note: 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.

2. Clone the examples repository and cd into the examples/httpserver-elixir1.16/ directory:

   git clone https://github.com/unikraft-cloud/examples
   cd examples/httpserver-elixir1.16/

Make sure to log into Unikraft Cloud and pick a metro close to you. This guide uses fra (Frankfurt, 🇩🇪):

Using the unikraft CLI (Recommended)

unikraft login

or

Using the legacy kraft CLI

# Set Unikraft Cloud access token
export UKC_TOKEN=token
# Set metro to Frankfurt, DE
export UKC_METRO=fra

When done, invoke the following command to deploy this app on Unikraft Cloud:

Using the unikraft CLI (Recommended)

unikraft build . --output <my-org>/httpserver-elixir116:latest
unikraft run --metro fra \
  -m 1G \
  -p 443:3000/tls+http \
  --scale-to-zero policy=idle,cooldown-time=3000,stateful=true \
  --image <my-org>/httpserver-elixir116:latest

or

Using the legacy kraft CLI

kraft cloud deploy \
  -M 1Gi \
  -p 443:3000/tls+http \
  --scale-to-zero idle \
  --scale-to-zero-stateful \
  --scale-to-zero-cooldown 3s \
  .

The output shows the instance address and other details:

Using the unikraft CLI (Recommended)

metro:        fra
name:         httpserver-elixir116-qo9k3
uuid:         e5fbf089-b000-4b2d-a827-44a1f5d28f24
state:        starting
image:        <my-org>/httpserver-elixir116
resources:
  memory:     1024MiB
  vcpus:      1
service:
  uuid:       ddbc554c-3ce1-01ea-27d9-61690cb85717
  name:       small-water-tl8lr8am
  domains:
  - fqdn:     small-water-tl8lr8am.fra.unikraft.app
networks:
- uuid:       4e9f6ce2-9f8d-04ed-35e8-073582ac66bc
  private-ip: 10.0.3.4
  mac:        12:b0:a2:d1:d5:d4
timestamps:
  created:    just now

or

Using the legacy kraft CLI

[●] Deployed successfully!
 │
 ├───────── name: httpserver-elixir116-qo9k3
 ├───────── uuid: e5fbf089-b000-4b2d-a827-44a1f5d28f24
 ├──────── metro: https://api.fra.unikraft.cloud/v1
 ├──────── state: starting
 ├─────── domain: https://small-water-tl8lr8am.fra.unikraft.app
 ├──────── image: oci://unikraft.io/<my-org>/httpserver-elixir116@sha256:67f5df003758a1180932e931727f8cb7006bbbf6fdd84058e27fe05e4829bba0
 ├─────── memory: 1024 MiB
 ├────── service: small-water-tl8lr8am
 ├─ private fqdn: httpserver-elixir116-qo9k3.internal
 └─── private ip: 10.0.3.4

In this case, the instance name is httpserver-elixir116-qo9k3 and the address is https://small-water-tl8lr8am.fra.unikraft.app. They're different for each run.

Use curl to query the Unikraft Cloud instance of the Elixir-based HTTP web server:

curl https://small-water-tl8lr8am.fra.unikraft.app

Hello, World!

You can list information about the instance by running:

Using the unikraft CLI (Recommended)

unikraft instances list

METRO  NAME                        STATE    IMAGE                          ARGS  MEMORY  VCPUS  FQDN                                   CREATED
fra    httpserver-elixir116-qo9k3  running  <my-org>/httpserver-elixir116        1.0GiB  1      small-water-tl8lr8am.fra.unikraft.app  2 minutes ago

or

Using the legacy kraft CLI

kraft cloud instance list

NAME                        FQDN                                   STATE    STATUS       IMAGE                                                       MEMORY   VCPUS  ARGS  BOOT TIME
httpserver-elixir116-qo9k3  small-water-tl8lr8am.fra.unikraft.app  running  since 9mins  oci://unikraft.io/<my-org>/httpserver-elixir116@sha256:...  1.0 GiB  1            437.43 ms

When done, you can remove the instance:

Using the unikraft CLI (Recommended)

unikraft instances delete httpserver-elixir116-qo9k3

or

Using the legacy kraft CLI

kraft cloud instance remove httpserver-elixir116-qo9k3

To customize the app, update the files in the repository, listed below:

• lib/, mix.exs: the actual Elixir HTTP server implementation
• Kraftfile: the Unikraft Cloud specification
• Dockerfile: the Docker-specified app filesystem

The following options are available for customizing the app:

• If you only update the implementation in the lib/server.ex or lib/server/app.ex source code files, no other changes apply. If you add new source files in the lib/ directory, 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 COPY command in the Dockerfile.

• More extensive changes may require extending the Dockerfile (see Dockerfile syntax reference).

The following commands generate the current source code files and configuration file (mix.exs):

mix new --app server . --sup

Use a similar command to create a new app. Then update it and deploy it on Unikraft Cloud using the above instructions.

Use the --help option for detailed information on using Unikraft Cloud:

Using the unikraft CLI (Recommended)

unikraft --help

or

Using the legacy kraft CLI

kraft cloud --help

Or visit the CLI Reference or the legacy CLI Reference.