Copy page

Example apps

MongoDB

This guide shows you how to use MongoDB, a source-available, cross-platform, document-oriented database program.

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/mongodb/ directory:

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

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>/mongodb:latest
unikraft run --metro fra \
  -m 1G \
  -p 27017:27017/tls \
  --scale-to-zero policy=idle,cooldown-time=1000,stateful=true \
  --image <my-org>/mongodb:latest

The output shows the instance address and other details:

Code
metro:        fra
name:         mongodb-6tiuu
uuid:         99779597-0bdb-4160-b902-a160c3ab4b2a
state:        starting
image:        <my-org>/mongodb
resources:
  memory:     1024MiB
  vcpus:      1
service:
  uuid:       91309c0c-fd6f-271d-cab6-2694b0991fbe
  name:       bold-brook-khkwv7of
  domains:
  - fqdn:     bold-brook-khkwv7of.fra.unikraft.app
networks:
- uuid:       24cc79e5-bb3f-cdcd-fd5d-e4605015a228
  private-ip: 10.0.6.4
  mac:        12:b0:d7:7b:83:97
timestamps:
  created:    just now

In this case, the instance name is mongodb-6tiuu and the the address is bold-brook-khkwv7of.fra.unikraft.app which is different for each run.

You can use the mongosh client to connect to the server:

Code
mongosh "mongodb://bold-brook-khkwv7of.fra.unikraft.app:27017/?tls=true"

You should see output like:

Code
Current Mongosh Log ID:	69d7a077dc5d28998344ba88
Connecting to:		mongodb://bold-brook-khkwv7of.fra.unikraft.app:27017/?tls=true&directConnection=true&appName=mongosh+2.8.2
Using MongoDB:		6.0.13
Using Mongosh:		2.8.2

For mongosh info see: https://docs.mongodb.com/mongodb-shell/

To help improve our products, anonymous usage data is collected and sent to MongoDB periodically (https://www.mongodb.com/legal/privacy-policy).
You can opt-out by running the disableTelemetry() command.

test>

You can list information about the instance by running:

Code
unikraft instances list

Code
METRO  NAME           STATE    IMAGE             ARGS  MEMORY  VCPUS  FQDN                                  CREATED
fra    mongodb-6tiuu  running  <my-org>/mongodb        1.0GiB  1      bold-brook-khkwv7of.fra.unikraft.app  2 minutes ago

When done, you can remove the instance:

Code
unikraft instances delete mongodb-6tiuu

Using volumes

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

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

Then start the MongoDB instance and mount that volume:

Code
unikraft build . --output <my-org>/mongodb:latest
unikraft run --metro fra \
  -m 1G \
  -p 27017:27017/tls \
  --scale-to-zero policy=idle,cooldown-time=1000,stateful=true \
  --volume mongodb-store:/data/db \
  --image <my-org>/mongodb: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.