Skip to content

Commit 6efa7ab

Browse files
nammndan-mckeanJulien-Ben
authored
release - Update README.md (#85)
# Summary <!-- Enter your issue summary here.--> ## Proof of Work <!-- Enter your proof that it works here.--> ## Checklist - [ ] Have you linked a jira ticket and/or is the ticket in the title? - [ ] Have you checked whether your jira ticket required DOCSP changes? - [ ] Have you checked for release_note changes? ## Reminder (Please remove this when merging) - Please try to Approve or Reject Changes the PR, keep PRs in review as short as possible - Our Short Guide for PRs: [Link](https://docs.google.com/document/d/1T93KUtdvONq43vfTfUt8l92uo4e4SEEvFbIEKOxGr44/edit?tab=t.0) - Remember the following Communication Standards - use comment prefixes for clarity: * **blocking**: Must be addressed before approval. * **follow-up**: Can be addressed in a later PR or ticket. * **q**: Clarifying question. * **nit**: Non-blocking suggestions. * **note**: Side-note, non-actionable. Example: Praise * --> no prefix is considered a question --------- Co-authored-by: Dan Mckean <[email protected]> Co-authored-by: Julien-Ben <[email protected]>
1 parent b5c6c18 commit 6efa7ab

File tree

1 file changed

+55
-8
lines changed

1 file changed

+55
-8
lines changed

README.md

Lines changed: 55 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,59 @@
1-
# Ops Manager Operator #
1+
[![Documentation](https://img.shields.io/badge/Documentation-MongoDB-green)](https://www.mongodb.com/docs/kubernetes/current/)
22

3-
<img align="left" src="https://mongodb-kubernetes-operator.s3.amazonaws.com/img/Leaf-Forest%402x.png">
3+
# Mongodb Controllers for Kubernetes (MCK)
44

5-
This is a Kubernetes Operator (https://coreos.com/operators/) to work
6-
with Ops Manager and Kubernetes clusters. It allows you to easily add new
7-
MongoDB deployments (standalones, replica sets, sharded clusters) to your Kubernetes cluster, configure them (modify, scale up/down, remove) and to manage them from your
8-
Ops Manager installation. This provides the combined power of Kubernetes (native scheduling of applications to nodes, scaling, fault tolerance etc) with Ops Manager capabilities (monitoring, backup, upgrades etc).
5+
## What is MCK
6+
Mongodb Controllers for Kubernetes (MCK) is a Kubernetes operator that enables users to run MongoDB in Kubernetes.
97

10-
## Development
8+
It supports both MongoDB Community and MongoDB Enterprise Advanced.
9+
10+
For **MongoDB Enterprise Advanced**, it supports:
11+
* Manages MongoDB Enterprise Advanced deployments in Kubernetes.
12+
* Integrates with MongoDB Ops Manager or Cloud Manager for advanced monitoring, backups, and automation.
13+
* Supports all MongoDB topologies: replica sets, standalone, and sharded clusters.
14+
For a full list of capabilities, see the [official documentation](https://www.mongodb.com/docs/kubernetes-operator/current/).
15+
16+
For **MongoDB Community**, it supports:
17+
* Manages MongoDB Community Server [replica sets](https://www.mongodb.com/docs/manual/replication/)
18+
* No integration with Ops Manager or Cloud Manager
19+
* Create & manage database users, leveraging [SCRAM authentication](https://www.mongodb.com/docs/manual/core/security-scram/)
20+
* Create & manage custom roles
21+
* Integrate [with Prometheus](https://github.com/mongodb/mongodb-kubernetes/blob/master/docs/mongodbcommunity/prometheus/README.md)
22+
23+
See [more info](#how-does-mck-differ-from-the-mongodb-enterprise-kubernetes-operator-or-mongodb-community-operator) below for guidance about how MCK differs from other MongoDB Operators, and how to migrate to MCK.
24+
25+
## Getting Started & Further Documentation
26+
* For guidance on using the Operator for Enterprise Advanced, please refer to our official [documentation](https://www.mongodb.com/docs/kubernetes/current/).
27+
*For guidance on using the Operator for MongoDB Community Edition, please refer to the [guidance in this repository](https://github.com/mongodb/mongodb-kubernetes/tree/master/mongodb-community-operator).
28+
29+
## License
30+
Customers with contracts that allowed use of the Enterprise Operator will still be able to leverage the new replacement, allowing customers to adopt it without contract changes. The Operator itself is licensed under the Apache 2.0, and a license file [included in the repository](LICENSE-MCK) provides further details. License entitlements for all other MongoDB products and tools remain unchanged (for example Enterprise Server and Ops Manager) - if in doubt, contact your MongoDB account team.
31+
32+
## Support, Feature Requests and Community
33+
MCK is supported by the [MongoDB Support Team](https://support.mongodb.com/). If you need help, please file a support ticket. If you have a feature request, you can make one on our [Feedback Site](https://feedback.mongodb.com/forums/924355-ops-tools)
34+
35+
You can discuss this integration in our new [Community Forum](https://developer.mongodb.com/community/forums/) - please use the tag [kubernetes-operator](https://developer.mongodb.com/community/forums/tag/kubernetes-operator)
36+
37+
## How does MCK differ from the MongoDB Enterprise Kubernetes Operator or MongoDB Community Operator?
38+
MCK unifies MongoDB's support for running MongoDB in Kubernetes into a single Operator.
39+
40+
This unifies:
41+
* [MongoDB Enterprise Kubernetes Operator](https://www.mongodb.com/docs/kubernetes-operator/current/)
42+
* [MongoDB Community Operator](https://github.com/mongodb/mongodb-kubernetes-operator)
43+
44+
While early versions of MCK simply bring the capabilities of both previous Operators into a single new Operator, future changes will build on this to more closely align how Community and Enterprise are managed in Kubernetes to offer an even more seamless and streamlined experience.
45+
46+
As an open-source project, MCK allows for community contributions, helping drive quicker bug fixes and ongoing innovation.
47+
48+
### Deprecation and EOL for MCO and MEKO
49+
* [MongoDB Community Operator](https://github.com/mongodb/mongodb-kubernetes-operator) End-of-Life (EOL): We will continue best efforts support for 6 months (until November, 2025)
50+
* [MongoDB Enterprise Kubernetes Operator](https://www.mongodb.com/docs/kubernetes-operator/current/) End-of-Life (EOL): No change to the [current EOL](https://www.mongodb.com/docs/kubernetes-operator/current/reference/support-lifecycle/) for each individual MEKO version.
51+
52+
No impact on current contracts or agreements.
53+
54+
### Migration
55+
Migration from [MongoDB Community Operator](https://github.com/mongodb/mongodb-kubernetes-operator) and [MongoDB Enterprise Kubernetes Operator](https://www.mongodb.com/docs/kubernetes-operator/current/) to MCK is seamless: your MongoDB deployments are not impacted by the upgrade and require no changes. Simply follow the upgrade instructions provided in the MCK documentation. See our [migration guidance](https://dochub.mongodb.org/core/migrate-to-mck).
56+
See our detailed migration guides:
57+
- [Migrating from MongoDB Community Operator](docs/migration/community-operator-migration.md)
58+
- [Migrating from MongoDB Enterprise Kubernetes Operator](https://www.mongodb.com/docs/kubernetes/current/tutorial/migrate-to-mck/)
1159

12-
Please see the [starting guide](https://wiki.corp.mongodb.com/display/MMS/Setting+up+local+development+and+E2E+testing).

0 commit comments

Comments
 (0)