Charmed MongoDB K8s | Home

charm
, , ,
1

Charmed MongoDB K8s Documentation

Charmed MongoDB K8s is an open-source software operator that deploys and operates MongoDB databases on Kubernetes.

In addition to MongoDB’s essential operations for managing production-grade deployments, Charmed MongoDB K8s offers advanced features such as backup and restores, monitoring, easy application integrations, sharding, and encryption.

Charmed MongoDB K8s was created to reduce the complexity of the deployment, scaling, and the operational challenges of MongoDB database operations. Built on top of Canonical’s Charm SDK and Juju 3, it wraps the expertise of a real-world operations team into a single charm that greatly simplifies the management of all kinds of data infrastructures using the Kubernetes container orchestration system.

This charm is for anyone looking for a complete database management interface on Kubernetes. This could be a team of system administrators maintaining large data infrastructures, a software developer who wants to connect a database to their application, or even someone curious to learn more about database charms through our tutorials.

:construction: Notice: Due to limitations in the MongoDB driver, the MongoDB replica set is not accessible outside the K8s environment.

We are implementing a proxy via mongos which will make this possible. Until then, you can try out Charmed MongoDB VM.

This operator is built for Kubernetes.

For deployments in IAAS/VM environments, see Charmed MongoDB VM.

In this documentation
Tutorials
Get started - a hands-on introduction to using the Charmed MongoDB operator for new users
How-to guides
Step-by-step guides covering key operations and common tasks
Reference
Technical information - specifications, APIs, architecture		 Explanation
Concepts - discussion and clarification of key topics

Project and community

Charmed MongoDB K8s is an open source project that warmly welcomes community contributions, suggestions, fixes, and constructive feedback.

Licensing & Trademark

The Charmed MongoDB K8s Operator is free software, distributed under the Apache Software License, version 2.0. It installs, operates, and depends on MongoDB Community Version, which is licensed under the Server Side Public License (SSPL)

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

Navigation

Level Path Navlink
1 tutorial Tutorial
2 t-overview 1. Introduction
2 t-environment-setup 2. Environment Setup
2 t-deploy-mongodb 3. Deploy MongoDB
2 t-managing-units 4. Manage your units
2 t-manage-passwords 5. Manage passwords
2 t-relate-mongodb 6. Relate MongoDB
2 t-enable-security 7. Enable security
2 t-cleanup-environment 8. Cleanup environment
1 how-to How-To
2 h-manage-units Manage units
2 h-enable-encryption Enable encryption
2 h-manage-passwords Manage passwords
2 h-configure-s3 Configure S3
2 h-create-and-list-backups Create and list backups
2 h-restore-backup Restore backup
2 h-migrate-cluster-via-restore Cluster Migration with Restore
2 h-view-metrics View Metrics
2 h-audit-logging Audit logging
1 reference Reference
2 r-overview Reference
2 r-configuration Configuration
2 r-actions Actions
2 r-requirements Requirements
1 explanation Explanations
2 e-users Users

Redirects

Mapping table
Path Location