OpenShift Quick Start

Clone the MongoDB Enterprise Kubernetes Operator repository.

git clone https://github.com/mongodb/mongodb-enterprise-kubernetes.git

Create a namespace for your Kubernetes deployment.

By default, The Kubernetes Operator uses the mongodb namespace. To simplify your installation, consider creating a namespace labeled mongodb using the following kubectl command:

kubectl create namespace mongodb

Configure kubectl to default to your namespace.

If you have not already, run the following command to execute all kubectl commands in the namespace you created:

kubectl config set-context $(kubectl config current-context) --namespace=mongodb

Install the MongoDB Enterprise Kubernetes Operator

1. Invoke the following oc command to install the CustomResourceDefinitions for MongoDB deployments:

   oc apply -f crds.yaml

2. Add your <openshift-pull-secret> to the ServiceAccount definitions in the MongoDB Enterprise Kubernetes Operator YAML file.

   ---
   # Source: mongodb-enterprise-operator/templates/serviceaccount.yaml
   ---
   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: enterprise-operator
     namespace: mongodb
   imagePullSecrets:
    - name: <openshift-pull-secret>
   ---
   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: mongodb-enterprise-appdb
     namespace: mongodb
   imagePullSecrets:
    - name: <openshift-pull-secret>
   ---
   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: mongodb-enterprise-database-pods
     namespace: mongodb
   imagePullSecrets:
    - name: <openshift-pull-secret>

3. Invoke the following oc command to install Kubernetes Operator:

   oc apply -f mongodb-enterprise-openshift.yaml

Create credentials and store them as a secret.

Run the following command:

kubectl -n mongodb \
  create secret generic ops-manager-admin-key \
  --from-literal="publicKey=<publicKey>" \
  --from-literal="privateKey=<privateKey>"

Invoke the following command to create a ConfigMap.

cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: ConfigMap
metadata:
  name: my-project
  namespace: mongodb
data:
  projectName: myProjectName # this is an optional parameter; when omitted, the Operator creates a project with the resource name
  orgId: 5b890e0feacf0b76ff3e7183 # this is a required parameter
  baseUrl: https://ops.example.com:8443
EOF

Deploy the MongoDB replica set resource.

1. Copy and save the following YAML file:

   apiVersion: mongodb.com/v1
   kind: MongoDB
   metadata:
     name: demo-mongodb-cluster-1
     namespace: mongodb
   spec:
     members: 3
     version: 4.4.5-ent
     type: ReplicaSet
     security:
       authentication:
         enabled: true
         modes: ["SCRAM"]
     cloudManager:
       configMapRef:
         name: my-project
     credentials: organization-secret
     persistent: true
     podSpec:
       podTemplate:
         spec:
          containers:
           - name: mongodb-enterprise-database
             resources:
               limits:
                 cpu: 2
                 memory: 1.5G
               requests:
                 cpu: 1
                 memory: 1G
               persistence:
                 single:
                   storage: 10Gi

2. Run the following command:

   kubectl apply -f <replica-set-conf>.yaml

Create a secret with your database user password

You can choose to use a cleartext password or a Base64-encoded password. Plaintext passwords use stringData.password and Base64-encoded passwords use data.password.

For a cleartext password, create and save the following YAML file:

apiVersion: v1
kind: Secret
metadata:
  name: mms-user-1-password
  # corresponds to user.spec.passwordSecretKeyRef.name
type: Opaque
stringData:
  password: <my-plain-text-password>
  # corresponds to user.spec.passwordSecretKeyRef.key

For a Base64-encoded password, create and save the following YAML file:

apiVersion: v1
kind: Secret
metadata:
  name: mms-user-1-password
  # corresponds to user.spec.passwordSecretKeyRef.name
type: Opaque
data:
  password: <base-64-encoded-password>
  # corresponds to user.spec.passwordSecretKeyRef.key

Create a database user.

1. Copy and save the following MongoDB User Resource Specification file:

   apiVersion: mongodb.com/v1
   kind: MongoDBUser
   metadata:
     name: mms-scram-user-1
   spec:
     passwordSecretKeyRef:
       name: mms-user-1-password
       # Match to metadata.name of the User Secret
       key: password
     username: "mms-scram-user-1"
     db: "admin" #
     mongodbResourceRef:
       name: "demo-mongodb-cluster-1"
       # Match to MongoDB resource using authenticaiton
     roles:
     - db: "admin"
       name: "clusterAdmin"
     - db: "admin"
       name: "userAdminAnyDatabase"
     - db: "admin"
       name: "readWrite"
     - db: "admin"
       name: "userAdminAnyDatabase"

2. Run the following command:

   kubectl apply -f <database-user-conf>.yaml

Optional: View the newly created user in Cloud Manager or Ops Manager.

You can view the newly-created user in Cloud Manager or Ops Manager:

1. From the Project's Deployment view, click the Security tab.

2. Click the MongoDB Users nested tab.

Connect to the MongoDB replica set.

Perform the following steps in the Cloud Manager application:

1. Click Deployment in the left navigation.

2. Click for the deployment to which you want to connect.

3. Click Connect to this instance.

4. Run the connection command in a terminal to connect to the deployment.