Charmed MongoDB documentation¶
Charmed MongoDB is an open-source software operator that deploys and operates MongoDB databases on IAAS/VM and Kubernetes. In addition to MongoDB’s essential operations for managing production-grade deployments, Charmed MongoDB offers advanced features such as backup and restores, monitoring, easy application integrations, sharding, and encryption.
Charmed MongoDB 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.
This charm is for anyone looking for a complete database management interface. 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.
In this documentation¶
This documentation contains practical information about installing and operating Charmed MongoDB. It covers instructions for both VM and K8s substrates.
Get started¶
Learn about what’s in the charm, how to try it out, and perform the most common operations.
Charm overview: System requirements • Release notes
Deploy MongoDB: Quickstart • Guided tutorial • Terraform
Key operations: Scale your cluster • Connect to a client • Create a backup
Production deployments¶
Advanced deployments and operations focused on production scenarios and high availability.
Advanced configuration: Manage persistent storage • Enable LDAP
Upgrades and data migration: Minor upgrades • Upgrade from MongoDB 6 to 8 • Migrate a cluster
Security: TLS encryption • Hardening guide
Troubleshooting: Monitoring • Advanced statuses
Charm developers¶
Information for developers looking to make their application compatible with MongoDB.
Libraries and interfaces:
mongodb_clientinterfaceLearn more about the charm: Internal users • Sharding
How this documentation is organised¶
This documentation uses the Diátaxis documentation structure :
The Tutorial provides step-by-step guidance for a beginner through the basics of a deployment in a local machine.
How-to guides are more focused, and assume you already have basic familiarity with the product.
Reference contains structured information for quick lookup, such as system requirements and configuration parameters
Explanation gives more background and context about key topics
Project and community¶
Charmed MongoDB is an open source project that warmly welcomes community contributions, suggestions, fixes, and constructive feedback.