Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.46 KB

README.md

File metadata and controls

76 lines (50 loc) · 2.46 KB
Raw

SurrealDB

This directory contains the SurrealDB runtime on Unikraft, in binary compatibility mode. It implements a simple HTTP server running on Unikraft that provides a simple response to each request.

Run and Use

Use kraft to run the image and start a Unikraft instance:

kraft run --rm -M 512M -p 8080:8080 --plat qemu --arch x86_64 unikraft.org/surreal:11.2

If the --plat argument is left out, it defaults to qemu. If the --arch argument is left out, it defaults to your system's CPU architecture.

Once executed, it will open port 8080 and wait for connections. To test it, you can use curl:

curl localhost:8080

You should see a "Hello, World!" message.

Inspect and Close

To list information about the Unikraft instance, use:

kraft ps -a
NAME        KERNEL                         ARGS                                    CREATED         STATUS   MEM   PORTS                   PLAT
goofy_enos  project://surreal:qemu/x86_64  /usr/bin/surreal start -u root -p root  14 seconds ago  running  488M  0.0.0.0:8080->8080/tcp  qemu/x86_64

The instance name is goofy_enos. To close the Unikraft instance, close the kraft process (e.g., via Ctrl+c) or run:

kraft rm goofy_enos

Build and Run Locally

The commands so far used the pre-built Surreal image available in the Unikraft registry.

In oder to to build a local Surreal image, clone this repository and cd into this directory. Then use kraft to build an image locally:

kraft build --no-cache --no-update --plat qemu --arch x86_64

Similar to the kraft run command, if the --plat argument is left out, it defaults to qemu. If the --arch argument is left out, it defaults to your system's CPU architecture.

In order to run the locally built image, use . (dot, the current directory) as the final argument to the kraft run command:

kraft run --rm -M 512M -p 8080:8080 --plat qemu --arch x86_64 .

Same as above, it will open port 8080 and wait for connections.

kraft and sudo

Mixing invocations of kraft and sudo can lead to unexpected behavior. Read more about how to start kraft without sudo at https://unikraft.org/sudoless.

Learn More