Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mongodb/mongodb-kubernetes-operator

MongoDB Community Kubernetes Operator
https://github.com/mongodb/mongodb-kubernetes-operator

Last synced: about 2 months ago
JSON representation

MongoDB Community Kubernetes Operator

Awesome Lists containing this project

README 

        
# MongoDB Community Kubernetes Operator #






This is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which deploys MongoDB Community into Kubernetes clusters.



If you are a MongoDB Enterprise customer, or need Enterprise features such as Backup, you can use the [MongoDB Enterprise Operator for Kubernetes](https://github.com/mongodb/mongodb-enterprise-kubernetes).



Here is a talk from MongoDB Live 2020 about the Community Operator:

* [Run it in Kubernetes! Community and Enterprise MongoDB in Containers](https://www.youtube.com/watch?v=2Xszdg-4T6A&t=1368s)



> **Note**

>

> Hi, I'm Dan Mckean 👋 I'm the Product Manager for MongoDB's support of Kubernetes.

>

> The [Community Operator](https://github.com/mongodb/mongodb-kubernetes-operator) is something I inherited when I started, but it doesn't get as much attention from us as we'd like, and we're trying to understand how it's used in order to establish it's future. It will help us establish exactly what level of support we can offer, and what sort of timeframe we aim to provide support in 🙂

>

>Here's a super short survey (it's much easier for us to review all the feedback that way!): [https://docs.google.com/forms/d/e/1FAIpQLSfwrwyxBSlUyJ6AmC-eYlgW_3JEdfA48SB2i5--_WpiynMW2w/viewform?usp=sf_link](https://docs.google.com/forms/d/e/1FAIpQLSfwrwyxBSlUyJ6AmC-eYlgW_3JEdfA48SB2i5--_WpiynMW2w/viewform?usp=sf_link)

>

> If you'd rather email me instead: [[email protected]](mailto:[email protected]?subject=MongoDB%20Community%20Operator%20feedback)



## Table of Contents



- [Documentation](#documentation)

- [Supported Features](#supported-features)

  - [Planned Features](#planned-features)

- [Contribute](#contribute)

- [License](#license)



## Documentation



See the [documentation](docs) to learn how to:



1. [Install or upgrade](docs/install-upgrade.md) the Operator.

1. [Deploy and configure](docs/deploy-configure.md) MongoDB resources.

1. [Configure Logging](docs/logging.md) of the MongoDB resource components.

1. [Create a database user](docs/users.md) with SCRAM authentication.

1. [Secure MongoDB resource connections](docs/secure.md) using TLS.



*NOTE: [MongoDB Enterprise Kubernetes Operator](https://www.mongodb.com/docs/kubernetes-operator/master/) docs are for the enterprise operator use case and NOT for the community operator. In addition to the docs mentioned above, you can refer to this [blog post](https://www.mongodb.com/blog/post/run-secure-containerized-mongodb-deployments-using-the-mongo-db-community-kubernetes-oper) as well to learn more about community operator deployment*



## Supported Features



The MongoDB Community Kubernetes Operator supports the following features:



- Create [replica sets](https://www.mongodb.com/docs/manual/replication/)

- Upgrade and downgrade MongoDB server version

- Scale replica sets up and down

- Read from and write to the replica set while scaling, upgrading, and downgrading. These operations are done in an "always up" manner.

- Report MongoDB server state via the [MongoDBCommunity resource](/config/crd/bases/mongodbcommunity.mongodb.com_mongodbcommunity.yaml) `status` field

- Use any of the available [Docker MongoDB images](https://hub.docker.com/_/mongo/)

- Connect to the replica set from inside the Kubernetes cluster (no external connectivity)

- Secure client-to-server and server-to-server connections with TLS

- Create users with [SCRAM](https://www.mongodb.com/docs/manual/core/security-scram/) authentication

- Create custom roles

- Enable a [metrics target that can be used with Prometheus](docs/prometheus/README.md)



## Contribute



Before you contribute to the MongoDB Community Kubernetes Operator, please read:



- [MongoDB Community Kubernetes Operator Architecture](docs/architecture.md)

- [Contributing to MongoDB Community Kubernetes Operator](docs/contributing.md)



Please file issues before filing PRs. For PRs to be accepted, contributors must sign our [CLA](https://www.mongodb.com/legal/contributor-agreement).



Reviewers, please ensure that the CLA has been signed by referring to [the contributors tool](https://contributors.corp.mongodb.com/) (internal link).



## Linting



This project uses the following linters upon every Pull Request:



* `gosec` is a tool that find security problems in the code

* `Black` is a tool that verifies if Python code is properly formatted

* `MyPy` is a Static Type Checker for Python

* `Kube-linter` is a tool that verified if all Kubernetes YAML manifests are formatted correctly

* `Go vet` A built-in Go static checker

* `Snyk` The vulnerability scanner



## License



Please see the [LICENSE](LICENSE.md) file.