MongoDB Cluster In Kubernetes(1): Install MongoDB Ops Manager

Posted on Edited on In 评论: Views:

It's pretty easy to configure a MongoDB standalone instance (almost zero configuration). However, if you want to run a production-level MongoDB cluster, the configuration process is non-trivial. For a production cluster, replication/sharding/dyanmic scaling/backup/transport encryption/monitoring are required. Is there a nice tool to help us?

MongoDB cluster is a distributed system, which is well suited to run in Kubernetes. However, the collaboration of MongoDB instances usually need to manually run commands on each instance which is independent of Kubernetes. Therefore, MongoDB Enterprise Kubernetes Operator is developed to mitigate the gap. Morever, MongoDB Ops Manager is a great web portal to help these automation tasks.

The whole deployment and configure process is a little bit long, I wrote a series of small pieces to make each of them compact and easy to follow:

  1. Install MongoDB Ops Manager
  2. Create a UserDB ReplicaSet
  3. Expose UserDB to Public
  4. Openssl Generates Self-signed Certificates
  5. Enable UserDB TLS and Auth

Prerequisites

  • Have a Kubernetes cluster
  • Basic understanding of MongoDB
  • Basic understanding of Kubernetes deployment/service/statefulset
  • Familiar with kubectl operations

This is part1, we first introduce the MongoDB Ops Manager components, then install it into your Kubernetes cluster.

MongoDB Ops Manager Kubernetes Overview

A simple diagram to illustrate the MongoDB Ops Manager architecture: MongoDB Ops Manager Architecture Kubernetes Deployment：

Kubernetes StatefulSet：

  • Ops Manager: MongoDB Ops Manager web portal, need a persistent volume
  • Application Database: Ops Manager backend DB, default a 3 instances replicaset
  • User Database: created by Ops Manager, a 3 instance replicaset in this tutorial

Kubernetes Services:

  • Ops Manager Service: Ops Manager web service. Mongo Admin manipulates the projects and the MongoDB deployments by it
  • UserDB Services: exposed services for UserDB. Mongo Client connected to UserDB through these services

Install MongoDB Ops Manager in Kubernetes

The install process is not hard, just follow the official blog: # Part1: Running MongoDB Ops Manager in Kubernetes

Here we provide more details including kubernetes dashboard snapshots and command outputs.

Install MongoDB Enterprise Operator

$ kubectl create namespace mongodb
namespace/mongodb created

$ kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-enterprise-kubernetes/master/crds.yaml
Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply
customresourcedefinition.apiextensions.k8s.io/mongodb.mongodb.com configured
Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply
customresourcedefinition.apiextensions.k8s.io/mongodbusers.mongodb.com configured
Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply
customresourcedefinition.apiextensions.k8s.io/opsmanagers.mongodb.com configured
Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply
clusterrole.rbac.authorization.k8s.io/mongodb-enterprise-operator-mongodb-webhook configured

$ kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-enterprise-kubernetes/master/mongodb-enterprise.yaml
serviceaccount/mongodb-enterprise-operator created
clusterrole.rbac.authorization.k8s.io/mongodb-enterprise-operator-mongodb-certs unchanged
clusterrolebinding.rbac.authorization.k8s.io/mongodb-enterprise-operator-mongodb-webhook-binding configured
clusterrolebinding.rbac.authorization.k8s.io/mongodb-enterprise-operator-mongodb-certs-binding configured
role.rbac.authorization.k8s.io/mongodb-enterprise-operator created
rolebinding.rbac.authorization.k8s.io/mongodb-enterprise-operator created
serviceaccount/mongodb-enterprise-appdb created
serviceaccount/mongodb-enterprise-database-pods created
serviceaccount/mongodb-enterprise-ops-manager created
role.rbac.authorization.k8s.io/mongodb-enterprise-appdb created
rolebinding.rbac.authorization.k8s.io/mongodb-enterprise-appdb created
deployment.apps/mongodb-enterprise-operator created

Tips: if your create a different namespace (not mongodb), you need to manually download the two yamls and modify its namespace to your own namespace name.

Here we created a deployment: mongodb-enterprise-operator, view it in the kubernetes dashboard：

MongoDB Enterprise Operator Deployment

Install MongoDB Ops Manager

Create Ops Manager Secret

$ kubectl create secret generic ops-manager-admin-secret --from-literal=Username="xxx@xxx.com"  --from-literal=Password="Test" --from-literal=FirstName="Last" --from-literal=LastName="Last" -n mongodb
secret/ops-manager-admin-secret created

Remember the username and password, we will login to the portal by them later.

MongoDB Ops Manager Config: ops-manager.yaml

apiVersion: mongodb.com/v1
kind: MongoDBOpsManager
metadata:
  name: ops-manager
  namespace: mongodb
spec:
  # the version of Ops Manager distro to use
  version: 4.2.4

  # the name of the secret containing admin user credentials.
  adminCredentials: ops-manager-admin-secret

  externalConnectivity:
    type: LoadBalancer

  # the Replica Set backing Ops Manager. 
  # appDB has the SCRAM-SHA authentication mode always enabled
  applicationDatabase:
    members: 3

Apply ops-manager.yaml

$ kubectl apply -f ops-manager.yaml
mongodbopsmanager.mongodb.com/ops-manager created

After execution, 3 statefulset are created:

  1. A 3 instances statefulset as Ops Manager backend DB
  2. A statefulset as Ops Manager web portal
  3. A statefuleset as backup daemon

Wait until these resource status becomes "Running": 

$ kubectl get om -n mongodb
NAME          REPLICAS   VERSION   STATE (OPSMANAGER)   STATE (APPDB)   STATE (BACKUP)   AGE   WARNINGS
ops-manager              4.2.4     Running              Running         Pending          18m
MongoDB Ops Manager Statefulset

View the services: MongoDB Ops Manager Services

Find the Ops Manager service ops-manager-svc-ext url：x.x.x.x:8080. Open it in the browser: MongoDB Ops Manager Login Page

Fill in the ops-manager-admin-secret username and password then login. A configuration page appears, complete it now or later by the Admin UI.

Delete Secret ops-manager-admin-secret

$ kubectl delete secret ops-manager-admin-secret -n mongodb
secret "ops-manager-admin-secret" deleted

The official tutorial said that it will never be used. I guess the username/password has been wrote to the backend DB. So just safely delete it.

Finish UI

MongoDB Ops Manager Deployment Processes

Note: the DB shown above is the backend DB of Ops Manager (aka Application Database), not the user database.

Next we will use MongoDB Kubernetes Operator to create user database:

Create a UserDB ReplicaSet

By the way, the official blog Part2 introduces some advanced features for your reference: # Part2: Ops Manager in Kubernetes