Skip to content

Commit

Permalink
Minimal documentation (#130)
Browse files Browse the repository at this point in the history
* Get Overview Section to a good standard. (#126)

* Get Overview Section to a good standard.

This PR refers to the JIRA task: "Overview Section for MongoDB VM brought to "good standard"" 

Standard for Overview can be seen [here](https://docs.google.com/spreadsheets/d/15KlgOKWCw6s2Tdl_CETlDGdqY5wixtUW0OustEGouTs/edit?usp=sharing)

[Kubeflow](https://charmed-kubeflow.io/docs) was used as inspiration for this task

* Update README.md

* Apply suggestions from code review

Co-authored-by: deusebio <[email protected]>

* fix typo

Co-authored-by: deusebio <[email protected]>
Co-authored-by: Mykola Marzhan <[email protected]>

* config options (#129)

* Requirements Section (#127)

* Requirements Section

This PR refers to the JIRA task: "Requirements Section for MongoDB VM brought to "good standard"" 

Standard for Overview can be seen [here](https://docs.google.com/spreadsheets/d/15KlgOKWCw6s2Tdl_CETlDGdqY5wixtUW0OustEGouTs/edit?usp=sharing)

[Kubeflow](https://charmed-kubeflow.io/docs) was used as inspiration for this task along with the [Percona MongoDB Requirements](https://docs.percona.com/percona-operator-for-mongodb/System-Requirements.html)

* Update README.md

* Update README.md

* resolving PR comments

Co-authored-by: deusebio <[email protected]>
Co-authored-by: Mykola Marzhan <[email protected]>
  • Loading branch information
3 people authored Nov 29, 2022
1 parent b0b9f65 commit 17a96f7
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,30 @@
# Charmed MongoDB Operator


## Description
## Overview

The Charmed MongoDB Operator delivers automated operations management from day 0 to day 2 on the [MongoDB Community Edition](https://github.com/mongodb/mongo) document database.
The Charmed MongoDB Operator delivers automated operations management from day 0 to day 2 on the [MongoDB Community Edition](https://github.com/mongodb/mongo) document database. It is an open source, end-to-end, production ready data platform on top of cloud native technologies.

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.
MongoDB is a popular NoSQL database application. It stores its data with JSON-like documents creating a flexible experience for users; with easy to use data aggregation for data analytics. It is a distributed database, so vertical and horizontal scaling come naturally.

This operator charm deploys and operates MongoDB on physical or virtual machines. It offers features such as replication, TLS, password rotation, and easy to use integration with applications. The Charmed MongoDB Operator meets the need of deploying MongoDB in a structured and consistent manner while allowing the user flexibility in configuration. It simplifies deployment, scaling, configuration and management of MongoDB in production at scale in a reliable way.

## Requirements
- 2GB of RAM.
- 2 CPU threads per host.
- For production deployment: at least 60GB of available storage on each host.
- Access to the internet for downloading the charm.
- Machine is running Ubuntu 20.04(focal) or later.

## Config options
auto-delete - `boolean`; When a relation is removed, auto-delete ensures that any relevant databases
associated with the relation are also removed. Set with `juju config mongodb auto-delete=<bool>`.

admin-password - `string`; The password for the database admin. Set with `juju run-action mongodb/leader set-admin-password --wait`

tls external key - `string`; TLS external key for encryption outside the cluster. Set with `juju run-action mongodb/0 set-tls-private-key "external-key=$(base64 -w0 external-key-0.pem)" --wait`

tls internal key - `string`; TLS external key for encryption inside the cluster. Set with `juju run-action mongodb/0 set-tls-private-key "internal-key=$(base64 -w0 internal-key.pem)" --wait`

## Usage

Expand Down Expand Up @@ -143,6 +161,10 @@ Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines on enhan
## License
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.

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)

See [LICENSE](https://github.com/canonical/mongodb-operator/blob/main/LICENSE) for more information.

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

0 comments on commit 17a96f7

Please sign in to comment.