Copy page

Guides

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 CLI. Use the unikraft CLI or the legacy kraft 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, 🇩🇪):

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

The output shows the instance address and other details:

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:

When done, you can remove the instance:

Using volumes

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

Then start the MongoDB instance and mount that volume:

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:

Or visit the CLI Reference or the legacy CLI Reference.