Guides

Elixir

Copy page

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 kraft CLI tool and a container runtime engine, for example Docker.

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

Code
 
git clone https://github.com/kraftcloud/examples
cd examples/http-elixir1.16/

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

Code
 
# 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:

Code
 
kraft cloud deploy -p 443:3000 -M 1024 .

The output shows the instance address and other details:

Code
 
[●] Deployed successfully!
 │
 ├────────── name: elixir-qo9k3
 ├────────── uuid: e5fbf089-b000-4b2d-a827-44a1f5d28f24
 ├───────── state: running
 ├──────── domain: https://small-water-tl8lr8am.fra.unikraft.app
 ├───────── image: sha256:67f5df003758a1180932e931727f8cb7006bbbf6fdd84058e27fe05e4829bba0
 ├──────── memory: 1024 MiB
 ├─────── service: small-water-tl8lr8am
 ├── private fqdn: elixir-qo9k3.internal
 ├──── private ip: 172.16.3.4
 └────────── args: /usr/bin/wrapper.sh /usr/local/bin/mix run --no-halt

In this case, the instance name is elixir-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:

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

Code
 
Hello, World!

You can list information about the instance by running:

Code
 
kraft cloud instance list

Code
 
NAME          FQDN                                   STATE    STATUS       IMAGE              MEMORY   ARGS                                         BOOT TIME
elixir-qo9k3  small-water-tl8lr8am.fra.unikraft.app  running  since 9mins  sha256:67f5df0...  1.0 GiB  /usr/bin/wrapper.sh /usr/local/bin/mix r...  437.43 ms

When done, you can remove the instance:

Code
 
kraft cloud instance remove elixir-qo9k3

Customize your app

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

• lib/, mix.esx: the actual Elixir HTTP server
• 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):

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

Learn more

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

Code
 
kraft cloud --help

Or visit the CLI Reference.