Skip to content

Latest commit

 

History

History
49 lines (28 loc) · 2.31 KB

README.md

File metadata and controls

49 lines (28 loc) · 2.31 KB
Raw

Charmed MongoDB Operator

Description

The Charmed MongoDB Operator delivers automated operations management from day 0 to day 2 on the MongoDB Community Edition document database.

MongoDB is a general purpose distributed document database. This operator charm deploys and operates MongoDB (vs 5.0) on physical or virtual machines as a single replica.

Usage

Until the MongoDB Machine Charm is published, you need to follow the build & deploy instructions from CONTRIBUTING.md to deploy the charm.

After building the charm you may deploy a single unit of MongoDB using its default configuration

juju deploy ./mongodb_ubuntu-20.04-amd64.charm

It is customary to use MongoDB with replication. Hence usually more than one unit (preferably an odd number to prohibit a "split-brain" scenario) is deployed. To deploy MongoDB with multiple replicas, specify the number of desired units with the -n option.

juju deploy ./mongodb_ubuntu-20.04-amd64.charm -n <number_of_replicas>

To retrieve primary replica one can use the action get-primary on any of the units running MongoDB

juju run-action mongodb/<unit_number> get-primary --wait

Similarly, the primary replica is displayed as a status message in juju status, however one should note that this hook gets called on regular time intervals and the primary may be outdated if the status hook has not been called recently.

Relations

Supported relations:

There are currently no supported relations.

License

The Charmed MongoDB Operator is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.

Security

Security issues in the Charmed MongoDB Operator can be reported through LaunchPad. Please do not file GitHub issues about security issues.

Contributing

Please see the Juju SDK docs for guidelines on enhancements to this charm following best practice guidelines, and CONTRIBUTING.md for developer guidance.