# DragonflyDB

import { Tabs, TabsContent, TabsList, TabsTrigger } from "zudoku/ui/Tabs"

{/* vale off */}
{/* THIS FILE WAS AUTOGENERATED FROM THE PUBLIC EXAMPLE REPOSITORY. DO NOT EDIT THIS FILE DIRECTLY. */}


This guide shows you how to deploy [Dragonfly](https://www.dragonflydb.io/), a simple, performant, and cost-efficient in-memory data store.

To run this example, follow these steps:

1. Install the CLI.
   Use the [unikraft CLI](/cli/unikraft) or the legacy [kraft CLI](https://unikraft.org/docs/cli/install).
   You need a [BuildKit](https://github.com/moby/buildkit) builder. The easiest way to get one is via [Docker](https://docs.docker.com/engine/install/).
   Alternatively, you can also directly set up and use BuildKit, see the [quick start](https://github.com/moby/buildkit#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](https://github.com/unikraft-cloud/examples) and `cd` into the `examples/dragonflydb/` directory:

```bash
git clone https://github.com/unikraft-cloud/examples
cd examples/dragonflydb/
```

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

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft login
```

```bash title="kraft"
# Set Unikraft Cloud access token
export UKC_TOKEN=token
# Set metro to Frankfurt, DE
export UKC_METRO=fra
```

</CodeTabs>

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

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft build . --output <my-org>/dragonflydb:latest
unikraft run --scale-to-zero policy=off --metro fra -p 443:6379/http+tls -m 512M --image <my-org>/dragonflydb:latest
```

```bash title="kraft"
kraft cloud deploy --scale-to-zero off -p 443:6379/http+tls -M 512Mi .
```

</CodeTabs>

The output shows the instance address and other details:

<CodeTabs syncKey="cli">

```ansi title="unikraft"
metro:        fra
name:         dragonflydb-10zgk
uuid:         6282ef0c-2161-494c-a3f3-2d16055096c2
state:        [92mstarting[0m
image:        <my-org>/dragonflydb
resources:
  memory:     512MiB
  vcpus:      1
service:
  uuid:       18326b44-a571-6195-b9e6-9368832ff2b3
  name:       dry-moon-x6bgl6c0
  domains:
  - fqdn:     dry-moon-x6bgl6c0.fra.unikraft.app
networks:
- uuid:       87aa7a40-2a83-f315-b656-e07a8637af64
  private-ip: 10.0.6.5
  mac:        12:b0:8f:c2:51:55
timestamps:
  created:    just now
```

```ansi title="kraft"
[90m[[0m[92m●[0m[90m][0m Deployed successfully!
 [90m│[0m
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mname[0m: dragonflydb-10zgk
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90muuid[0m: 6282ef0c-2161-494c-a3f3-2d16055096c2
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mmetro[0m: https://api.fra.unikraft.cloud/v1
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mstate[0m: [92mstarting[0m
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mdomain[0m: https://dry-moon-x6bgl6c0.fra.unikraft.app
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mimage[0m: oci://unikraft.io/<my-org>/dragonflydb@sha256:21e6d3ff1f86292e14266bcf5c6e73d3b7a86a0ec4102c66a0961373af743f19
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mmemory[0m: 512 MiB
 [90m├[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m[90m─[0m [90mservice[0m: dry-moon-x6bgl6c0
 [90m├[0m[90m─[0m [90mprivate fqdn[0m: dragonflydb-10zgk.internal
 [90m└[0m[90m─[0m[90m─[0m[90m─[0m [90mprivate ip[0m: 10.0.6.5
```

</CodeTabs>

In this case, the instance name is `dragonflydb-10zgk` and the address is `https://dry-moon-x6bgl6c0.fra.unikraft.app`.
They're different for each run.

Use `curl` to query the Unikraft Cloud instance of Drangonfly.

```bash
curl https://dry-moon-x6bgl6c0.fra.unikraft.app
```

```html
<!DOCTYPE html>
<html><head>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
    <link href='https://fonts.googleapis.com/css?family=Roboto:400,300' rel='stylesheet'
     type='text/css'>
    <link rel='stylesheet' href='http://static.dragonflydb.io/data-plane/status_page.css'>
    <script type="text/javascript" src="http://static.dragonflydb.io/data-plane/status_page.js"></script>
</head>
<body>
<div><img src='http://static.dragonflydb.io/data-plane/logo.png' width="160"/></div>
<div class='left_panel'></div>
<div class='styled_border'>
<div>Status:<span class='key_text'>OK</span></div>
<div>Started on:<span class='key_text'>1970-01-01T00:00:00</span></div>
<div>Uptime:<span class='key_text'>474611:3:38</span></div>
<div>Render Latency:<span class='key_text'>110 us</span></div>
</div>
</body>
<script>
var json_text1 = {"engine": { "keys": 0,"obj_mem_usage": 0,"table_load_factor": 0 },
"current-time": 1708599818};
document.querySelector('.left_panel').innerHTML = JsonToHTML(json_text1);
</script>
</html>
```

You can list information about the instance by running:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft instances list
```

```bash title="kraft"
kraft cloud instance list
```

</CodeTabs>

<CodeTabs syncKey="cli">

```ansi title="unikraft"
[1mMETRO[0m  [1mNAME[0m               [1mSTATE[0m    [1mIMAGE[0m                 [1mARGS[0m  [1mMEMORY[0m  [1mVCPUS[0m  [1mFQDN[0m                                [1mCREATED[0m
fra    dragonflydb-10zgk  [92mrunning[0m  <my-org>/dragonflydb        512MiB  1      dry-moon-x6bgl6c0.fra.unikraft.app  2 minutes ago
```

```ansi title="kraft"
[1mNAME[0m               [1mFQDN[0m                                [1mSTATE[0m    [1mSTATUS[0m        [1mIMAGE[0m                                              [1mMEMORY[0m   [1mVCPUS[0m  [1mARGS[0m  [1mBOOT TIME[0m
dragonflydb-10zgk  dry-moon-x6bgl6c0.fra.unikraft.app  [92mrunning[0m  1 minute ago  oci://unikraft.io/<my-org>/dragonflydb@sha256:...  512 MiB  1            28.74 ms
```

</CodeTabs>

When done, you can remove the instance:

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft instances delete dragonflydb-10zgk
```

```bash title="kraft"
kraft cloud instance remove dragonflydb-10zgk
```

</CodeTabs>

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

<CodeTabs syncKey="cli">

```bash title="unikraft"
unikraft --help
```

```bash title="kraft"
kraft cloud --help
```

</CodeTabs>

Or visit the [CLI Reference](/cli/unikraft) or the [legacy CLI Reference](/cli/kraft/overview).
{/* vale on */}
