Welcome to the MongoDB Enterprise Kubernetes Operator. The Operator enables easy deploys of MongoDB into Kubernetes clusters, using our management, monitoring and backup platforms, Ops Manager and Cloud Manager. By installing this integration, you will be able to deploy MongoDB instances with a single simple command.
Please note that this project is currently in beta, and is not yet recommended for production use.
You can discuss this integration in our Slack - join the #enterprise-kubernetes channel.
Kubernetes Resource Specification
Known Issues for Kubernetes Operator
The MongoDB Enterprise Operator is compatible with Kubernetes v1.9 and above. It has been tested against Openshift 3.9.
This Operator requires Ops Manager or Cloud Manager. In this document, when we refer to "Ops Manager", you may substitute "Cloud Manager". The functionality is the same.
This operator can also be installed using yaml files, in case you are not using Helm. You may apply the config directly from github clone this repo, and apply the file
kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-enterprise-kubernetes/master/mongodb-enterprise.yaml
or clone this repo, make any edits you need, and apply it from your machine.
kubectl apply -f mongodb-enterprise.yaml
If you have an Helm installation in your Kubernetes cluster, you can run:
helm install helm_chart/ --name mongodb-enterprise
For the Operator to work, you will need the following information:
- Base Url - the url of an Ops Manager instance
- Project Id - the id of a Project which MongoDBs will be deployed into.
- User - an Ops Manager username
- Public API Key - an Ops Manager Public API Key. Note that you must whitelist the IP range of your Kubernetes cluster so that the Operator may make requests to Ops Manager using this API Key.
This is documented in greater detail in our installation guide
A Project object is a Kubernetes ConfigMap that points to an Ops Manager installation and a Project. This ConfigMap has the following structure:
$ cat my-project.yaml
---
apiVersion: v1
kind: ConfigMap
metadata:
name: my-project
namespace: mongodb
data:
projectId: my-project-id # get this from Ops Manager
baseUrl: https://my-ops-manager-or-cloud-manager-url
Apply this file to create the new Project:
kubectl apply -f my-project.yaml
For a user to be able to create or update objects in this Ops Manager Project they need a Public API Key. These will be held by Kubernetes as a Secret object. You can create this Secret with the following command:
$ kubectl -n mongodb create secret generic my-credentials --from-literal="user=some@example.com" --from-literal="publicApiKey=my-public-api-key"In this example, a Secret object with the name my-credentials was created. The contents of this Secret object is the user and publicApiKey attribute. You can see this secret with a command like:
$ kubectl describe secrets/my-credentials -n mongodb
Name: my-credentials
Namespace: mongodb
Labels: <none>
Annotations: <none>
Type: Opaque
Data
====
publicApiKey: 41 bytes
user: 14 bytesWe can't see the contents of the Secret, because it is a secret!
This is good, it will allow us to maintain a separation between our
users.
A MongoDB object in Kubernetes can be a MongoDBStandalone, a MongoDBReplicaSet or a MongoDBShardedCluster. We are going to create a replica set to test that everything is working as expected. There is a MongoDBReplicaSet yaml file in samples/minimal/replicaset.yaml.
If you have a correctly created Project with the name my-project and Credentials stored in a secret called my-credentials then, after applying this file then everything should be running and a new Replica Set with 3 members should soon appear in Ops Manager UI.
kubectl apply -f samples/minimal/replicaset.yaml