Deploy 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 kraft CLI tool and a container runtime engine, e.g. Docker.

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

git clone https://github.com/kraftcloud/examples
cd examples/mariadb

Make sure to log into KraftCloud by setting your token and a metro close to you. We use fra0 (Frankfurt, 🇩🇪) in this guide:

# Set KraftCloud access token
export KRAFTCLOUD_TOKEN=token
# Set metro to Frankfurt, DE
export KRAFTCLOUD_METRO=fra0

When done, invoke the following command to deploy this application on KraftCloud:

kraft cloud deploy -p 3306:3306/tls -M 1024 .

The output shows the instance URL and other details:

[●] Deployed successfully!
 │
 ├────────── name: mariadb-w2g2z
 ├────────── uuid: ba696c22-adff-4fba-88b9-d1b790ca2357
 ├───────── state: running
 ├────────── fqdn: twilight-sun-82lt4ddk.fra0.kraft.host
 ├───────── image: mariadb@sha256:6e31d28b351eb12a070e3074f0a500532d0a494332947e9d8dbfa093d2d551fd
 ├───── boot time: 159.06 ms
 ├──────── memory: 1024 MiB
 ├─ service group: twilight-sun-82lt4ddk
 ├── private fqdn: mariadb-w2g2z.internal
 ├──── private ip: 172.16.6.3
 └────────── args: /usr/sbin/mariadbd --user=root --log-bin

In this case, the instance name is mariadb-w2g2z and the service group twilight-sun-82lt4ddk. They are different for each run.

To test the deployment, first forward the port with the kraft cloud tunnel command. Be sure to use the service group returned by the kraft cloud deploy command:

kraft cloud tunnel twilight-sun-82lt4ddk 3306:3306

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

mysql -h 127.0.0.1 -u root -punikraft mysql <<< "select count(*) from user"

You should see output such as:

count(*)
6

To disconnect, simply kill the tunnel command with ctrl-C

Note

We use kraft cloud tunnel only when a service doesn’t support TLS and is not HTTP-based (we use TLS/SNI to determine the correct instance to send traffic to). Also note that tunnel command is not needed when connecting via an instance’s private IP/FQDN, ie, when a MariaDB instance is used as a backend to another instance that acts as a frontend and which does support TLS.

At any point in time, you can list information about the instance:

kraft cloud instance list

NAME            FQDN                               STATE    CREATED AT    IMAGE                            MEMORY   ARGS                             BOOT TIME
mariadb-w2g2z   twilight-sun-82lt4ddk.fra0.kra...  running  1 minute ago  felipe.unikraft.io/mariadb@s...  1.0 GiB  /usr/sbin/mariadbd --user=ro...  159065us

When done, you can remove the instance:

kraft cloud instance remove mariadb-w2g2z

Customize your Application

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

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

Kraftfile

spec: v0.6

runtime: mariadb:latest

rootfs: ./Dockerfile

cmd: ["/usr/sbin/mariadbd", "--user=root", "--log-bin"]

Dockerfile

FROM debian:bookworm AS build

RUN set -xe \
    echo "Your code here"

FROM scratch

# Your files here
# COPY --from=build / /

Learn More

Use the --help option for detailed information on using KraftCloud:

kraft cloud --help

Or visit the CLI Reference.