Copy page

Example apps

MariaDB

This guide shows you how to use MariaDB, one of the most popular open source relational databases. To run it, follow these steps:

1. Install the unikraft 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.

2. Clone the examples repository and cd into the examples/mariadb/ directory:

   Code
   git clone https://github.com/unikraft-cloud/examples
   cd examples/mariadb

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

Code
unikraft login

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

Code
unikraft build . --output <my-org>/mariadb:latest
unikraft run --metro fra \
  -m 1G \
  -p 3306:3306/tls \
  --scale-to-zero policy=idle,cooldown-time=1000,stateful=true \
  -e MARIADB_ROOT_PASSWORD="unikraft" \
  --image <my-org>/mariadb:latest

The output shows the instance address and other details:

Code
metro:        fra
name:         mariadb-w2g2z
uuid:         ba696c22-adff-4fba-88b9-d1b790ca2357
state:        starting
image:        <my-org>/mariadb
resources:
  memory:     1024MiB
  vcpus:      1
service:
  uuid:       ca8ae7e9-3767-85f6-3d70-b77bcf894a7c
  name:       twilight-sun-82lt4ddk
  domains:
  - fqdn:     twilight-sun-82lt4ddk.fra.unikraft.app
networks:
- uuid:       935ba4ef-39c2-07e7-d2ae-8cd3c9aae07c
  private-ip: 10.0.6.3
  mac:        12:b0:ee:29:71:e4
timestamps:
  created:    just now

In this case, the instance name is mariadb-w2g2z which is different for each run.

To test the deployment, first forward the port with the socat command.

Code
socat TCP-LISTEN:3306,reuseaddr,fork OPENSSL:twilight-sun-82lt4ddk.fra.unikraft.app:3306,verify=0

You can now, on a separate console, use the mysql command line tool to test that the set up works:

Code
mysql -h 127.0.0.1 --ssl-mode=DISABLED -u root -punikraft mysql <<< "select count(*) from user"

Or use the mariadb client command line tool:

Code
mariadb -h 127.0.0.1 --ssl=OFF -u root -punikraft mysql <<< "select count(*) from user"

You should see output such as:

Code
count(*)
6

To disconnect, kill the socat command using Ctrl+c.

You can list information about the instance by running:

Code
unikraft instances list

Code
METRO  NAME           STATE    IMAGE             ARGS  MEMORY   VCPUS  FQDN                                    CREATED
fra    mariadb-w2g2z  running  <my-org>/mariadb        1024MiB  1      twilight-sun-82lt4ddk.fra.unikraft.app  2 minutes ago

When done, you can remove the instance:

Code
unikraft instance remove mariadb-w2g2z

Using volumes

You can use volumes for data persistence for your MariaDB instance. For that you would first create a volume:

Code
unikraft volume create --set metro=fra --set name=mariadb-store --set size=512M

Then start the MariaDB instance and mount that volume:

Code
unikraft build . --output <my-org>/mariadb:latest
unikraft run --metro fra \
  -m 1G \
  -p 3306:3306/tls \
  --scale-to-zero policy=idle,cooldown-time=1000,stateful=true \
  -e MARIADB_ROOT_PASSWORD="unikraft" \
  --volume mariadb-store:/var/lib \
  --image <my-org>/mariadb:latest

Customize your app

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

• Kraftfile: the Unikraft Cloud specification, including command-line arguments
• Dockerfile: In case you need to add files to your instance's rootfs

Learn more

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

Code
unikraft --help

Or visit the CLI Reference.