Charmed MongoDB

  • By Data Platform
Channel Version Revision Published Runs on
latest/stable 14 14 01 Aug 2022
Ubuntu 20.04
latest/edge 16 16 03 Aug 2022
Ubuntu 20.04
juju deploy mongodb-k8s --channel edge
Show information


Charmed MongoDB Operator

A Charmed MongoDB operator delivers automated operations management from day 0 to 2 for the MongoDB Community Edition document database.

This repository contains a Juju Charm for deploying MongoDB on Kubernetes clusters.


A typical setup using snaps, for deployments to a microk8s cluster can be done using the following commands

sudo snap install microk8s --classic
microk8s.enable dns storage registry dashboard
sudo snap install juju --classic
juju bootstrap microk8s microk8s
juju create-storage-pool operator-storage kubernetes storage-class=microk8s-hostpath


Install the charmcraft tool

sudo snap install charmcraft --classic

Build the charm in this git repository

charmcraft pack


Create a Juju model for your operators, say "lma"

juju add-model lma

Deploy a single unit of MongoDB using its default configuration

juju deploy ./mongodb-k8s_ubuntu-20.04-amd64.charm --resource mongodb-image=mongo:4.4.1

It is customary to use MongoDB with replication. Hence usually more than one unit (preferably and odd number) is deployed. Additionally units (say two more) may be deployed using

juju add-unit -n 2 mongodb

Alternatively multiple MongoDB units may be deployed at the outset. This is usually faster

juju deploy -n 3 ./mongodb-k8s_ubuntu-20.04-amd64.charm --resource mongodb-image=mongo:4.4.1

If required, remove the deployed monitoring model completely

juju destroy-model -y lma --no-wait --force --destroy-storage

Note the --destroy-storage will delete any data stored by MongoDB in its persistent store.


Currently supported relations are

  • Peer relations for replication
  • Provides a mongodb database interface.


Use your existing Python 3 development environment or create and activate a Python 3 virtualenv

virtualenv -p python3 venv
source venv/bin/activate

Install the development requirements

pip install -r requirements-dev.txt


Just run run_tests:



The Charmed MongoDB Operator is distributed under the Apache Software License, version 2.0. It [installs/operates/depends on] MongoDB Community Edition, which is licensed under the Server Side Public License (SSPL).

Trademark notice

MongoDB' is a trademark or registered trademark of MongoDB Inc. Other trademarks are property of their respective owners.