Skip to content

Commit

Permalink
Updated README.md (#382)
Browse files Browse the repository at this point in the history 
## Issue
README.md is out of sync with latest updates to the [MongoDB home page
on charmhub.io](https://charmhub.io/mongodb)
Jira issue: [DPE-3747](https://warthogs.atlassian.net/browse/DPE-3747)

## Solution
- Edited the text to match home page more closely
- Removed unnecessary or repeated information
- Added further links and resources 

[DPE-3747]:
https://warthogs.atlassian.net/browse/DPE-3747?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: Mich Tabirao <101575006+michtabirao@users.noreply.github.com>
  • Loading branch information
@a-velasco @michtabirao
a-velasco and michtabirao committed Mar 25, 2024
1 parent 3c35f67 commit 391e3e5
Showing 1 changed file with 26 additions and 41 deletions.
67 changes: 26 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,59 +5,44 @@

## Overview

[MongoDB](https://github.com/mongodb/mongo) is a popular NoSQL database application. It stores its data with JSON-like documents creating a flexible user experience with easy-to-use data aggregation for data analytics. In addition, it is a distributed database, so vertical and horizontal scaling come naturally.
[Charmed MongoDB](https://charmhub.io/mongodb) is an open-source software operator that deploys and operates MongoDB databases on IAAS/VM. You can deploy it on a stand-alone machine or cloud and cloud-like environments, including AWS, Azure, OpenStack and VMWare.

Applications like MongoDB must be managed and operated in the production environment. This means that MongoDB application administrators and analysts who run workloads in various infrastructures should be able to automate tasks for repeatable operational work. Technologies such as software operators encapsulate the knowledge, wisdom and expertise of a real-world operations team and codify it into a computer program that helps to operate complex server applications like MongoDB and other databases.
This charm was created to reduce the complexity of the deployment, scaling, and operational challenges of MongoDB database operations.

Canonical has developed an open-source operator called Charmed MongoDB, making it easier to operate MongoDB. The Charmed MongoDB Virtual Machine (VM) operator deploys and operates MongoDB on physical, Virtual Machines (VM) and other wide range of cloud and cloud-like environments, including AWS, Azure, OpenStack and VMWare.

Charmed MongoDB (VM Operator) is an enhanced, open source and fully-compatible drop-in replacement for the MongoDB Community Edition with advanced MongoDB enterprise features. It simplifies the deployment, scaling, design and management of MongoDB in production in a reliable way. In addition, you can use the operator to manage your MongoDB clusters with automation capabilities. It also offers replication, TLS, password rotation, easy-to-use application integration, backup, restore, and monitoring.

Aside from a VM operator, Canonical also developed another operator called [Charmed MongoDB (K8s operator)](https://charmhub.io/mongodb-k8s?channel=5/edge) that operates in the Kubernetes environment, and you can see the documentation [here](https://charmhub.io/mongodb-k8s?channel=5/edge).
It currently supports:
* Replication
* Sharding
* Password rotation
* User management
* Client connections
* TLS encryption
* Backup & restore
* Monitoring
* Audit logging

> Check our official documentation at [Charmhub | Charmed MongoDB](https://charmhub.io/mongodb) for tutorials, guides, explanations, and other resources.
## Software and releases

Charmed MongoDB (VM Operator) is an enhanced, open source and fully-compatible drop-in replacement for the MongoDB Community Edition with advanced MongoDB enterprise features. This operator uses the [Charmed MongoDB snap package](https://snapcraft.io/charmed-mongodb), which offers more features than the MongoDB Community version, such as backup and restores, monitoring and security features.

To see the Charmed MongoDB features and releases, visit our [Release Notes page](https://github.com/canonical/mongodb-operator/releases). Currently the charm supports:
- Replication
- Password Rotation
- User management
- TLS
- Backup & Restore

## Charm version, environment and OS

A charm version is a combination of both the application version and / (slash) the channel, e.g. 5/stable, 5/candidate, 5/edge. The channels are ordered from the most stable to the least stable, candidate, and edge. More risky channels like edge are always implicitly available. So, if the candidate is listed, you can pull the candidate and edge. When stable is listed, all three are available.

You can deploy the charm a stand-alone machine or cloud and cloud-like environments, including AWS, Azure, OpenStack and VMWare.

The upper portion of this page describes the Operating System (OS) where the charm can run e.g. 5/stable is compatible and should run in a machine with Ubuntu 22.04 OS.


## Security, Bugs and feature request

If you find a bug in this snap or want to request a specific feature, here are the useful links:

* Raise issues or feature requests in [Github](https://github.com/canonical/mongodb-operator/issues)

* Security issues in the Charmed MongoDB Operator can be reported through [LaunchPad](https://wiki.ubuntu.com/DebuggingSecurity#How%20to%20File). Please do not file GitHub issues about security issues.
This operator uses the Charmed MongoDB [snap package](https://snapcraft.io/charmed-mongodb), which bundles MongoDB along with other useful tools for building a charmed operator.

* Meet the community and chat with us if there are issues and feature requests in our [Mattermost Channel](https://chat.charmhub.io/charmhub/channels/data-platform)
You can find information about all of this charm's revisions on [Charmhub | Charmed MongoDB](https://charmhub.io/mongodb).

## Contributing
For more details about features and releases, visit our [Release Notes](https://github.com/canonical/mongodb-operator/releases) on GitHub.

Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines on enhancements to this charm following best practice guidelines, and [CONTRIBUTING.md](https://github.com/canonical/mongodb-operator/blob/main/CONTRIBUTING.md) for developer guidance.
## Project & Community

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

The Charmed MongoDB Operator is free software, distributed under the Apache Software License, version 2.0. See [LICENSE](https://github.com/canonical/mongodb-operator/blob/main/LICENSE) for more information.
* Check our [Code of Conduct](https://ubuntu.com/community/ethos/code-of-conduct)
* Raise software issues or feature requests in [GitHub](https://github.com/canonical/mongodb-operator/issues)
* Report security issues through [LaunchPad](https://wiki.ubuntu.com/DebuggingSecurity#How%20to%20File).
* Meet the community and chat with us on [Matrix](https://matrix.to/#/#charmhub-data-platform:ubuntu.com)
* [Contribute](https://github.com/canonical/mongodb-operator/blob/main/CONTRIBUTING.md) to the code

The Charmed MongoDB Operator is free software, distributed under the Apache Software License, version 2.0. It [installs/operates/depends on] [MongoDB Community Version](https://github.com/mongodb/mongo), which is licensed under the Server Side Public License (SSPL)
## Licensing & Trademark

See [LICENSE](https://github.com/canonical/mongodb-operator/blob/main/LICENSE) for more information.
The Charmed MongoDB Operator is free software, distributed under the [Apache Software License, version 2.0](https://github.com/canonical/mongodb-operator/blob/main/LICENSE). It installs, operates, and depends on [MongoDB Community Version](https://github.com/mongodb/mongo) and [Percona Server for MongoDB](https://github.com/percona/percona-server-mongodb), 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.
“MongoDB” is a trademark or registered trademark of MongoDB Inc. Other trademarks are property of their respective owners. Charmed MongoDB is not sponsored, endorsed, or affiliated with MongoDB, Inc.

0 comments on commit 391e3e5

Please sign in to comment.