This example uses actix-web, a popular Rust web framework. To run it, 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-rust1.88-actix-web4/ directory:

   git clone https://github.com/unikraft-cloud/examples
   cd examples/httpserver-rust1.88-actix-web4/

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-rust188-actix-web4:latest
unikraft run --metro fra \
  -m 256M \
  -p 443:8080/tls+http \
  --scale-to-zero policy=on,cooldown-time=1000 \
  --image <my-org>/httpserver-rust188-actix-web4:latest

or

Using the legacy kraft CLI

kraft cloud deploy \
  -M 256Mi \
  -p 443:8080/tls+http \
  --scale-to-zero on \
  --scale-to-zero-cooldown 1s \
  .

The output shows the instance address and other details:

Using the unikraft CLI (Recommended)

metro:        fra
name:         httpserver-rust188-actix-web4-3pj27
uuid:         3e729de6-a1fb-5818-63d4-51a905fa6a5d
state:        starting
image:        <my-org>/httpserver-rust188-actix-web4
resources:
  memory:     256MiB
  vcpus:      1
service:
  uuid:       bf564711-3ec0-be8c-64ca-e27c5034d3fe
  name:       autumn-silence-wupu2nus
  domains:
  - fqdn:     autumn-silence-wupu2nus.fra.unikraft.app
networks:
- uuid:       53417e5b-ae43-6307-d433-9a22c0d249a9
  private-ip: 10.0.3.3
  mac:        12:b0:58:9f:9e:51
timestamps:
  created:    just now

or

Using the legacy kraft CLI

[●] Deployed successfully!
 │
 ├───────── name: httpserver-rust188-actix-web4-3pj27
 ├──────── metro: https://api.fra.unikraft.cloud/v1
 ├──────── state: starting
 ├─────── domain: https://autumn-silence-wupu2nus.fra.unikraft.app
 ├──────── image: oci://unikraft.io/<my-org>/httpserver-rust188-actix-web4@sha256:11723705230f0f4545d2be7e4867dc67b396870769e91f05e2fa6d9da94f9b59
 ├─────── memory: 256 MiB
 ├────── service: autumn-silence-wupu2nus
 ├─ private fqdn: httpserver-rust188-actix-web4-3pj27.internal
 └─── private ip: 10.0.3.3

In this case, the instance name is httpserver-rust188-actix-web4-3pj27 and the address is https://autumn-silence-wupu2nus.fra.unikraft.app. They're different for each run.

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

curl https://autumn-silence-wupu2nus.fra.unikraft.app
curl https://autumn-silence-wupu2nus.fra.unikraft.app/hey

Hello, World!
Hey there!

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-rust188-actix-web4-3pj27  running  <my-org>/httpserver-rust188-actix-web4        256MiB  1      autumn-silence-wupu2nus.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-rust188-actix-web4-3pj27  autumn-silence-wupu2nus.fra.unikraft.app  running  10 minutes ago  oci://unikraft.io/<my-org>/httpserver-rust188-actix-web4@sha256:...  256 MiB  1            11.67 ms

When done, you can remove the instance:

Using the unikraft CLI (Recommended)

unikraft instances delete httpserver-rust188-actix-web4-3pj27

or

Using the legacy kraft CLI

kraft cloud instance remove httpserver-rust188-actix-web4-3pj27

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

• src/main.rs: the actual server implementation
• Cargo.toml: the Cargo package manager configuration file
• 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 src/main.rs source file, 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. If you add new Rust source code files, be sure to configure required dependencies in the Cargo.toml file.

• If you build a new executable, update the cmd line in the Kraftfile and replace /server with the path to the new executable.

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

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.