93563f6dcd8b43cc2ce9a94c0e28c1f8289c3109: update public repo contents

Author: Anton Lisovenko

README.md

@@ -20,17 +20,18 @@ You can discuss this integration in our [Slack](https://community-slack.mongodb.
 
 [Kubernetes Resource Specification](https://docs.opsmanager.mongodb.com/current/reference/k8s-operator-specification)
 
+[Troubleshooting Kubernetes Operator](https://docs.opsmanager.mongodb.com/current/reference/troubleshooting/k8s/)
+
 [Known Issues for Kubernetes Operator](https://docs.opsmanager.mongodb.com/current/reference/known-issues-k8s-beta)
 
 ## Requirements ##
 
-The MongoDB Enterprise Operator is compatible with Kubernetes v1.9 and above. It has been tested against Openshift 3.9.
+The MongoDB Enterprise Operator is compatible with Kubernetes v1.11 and above. It has been tested against Openshift 3.11.
 
 This Operator requires [Ops Manager](https://docs.opsmanager.mongodb.com/current/) or [Cloud Manager](https://cloud.mongodb.com/user#/cloud/login). In this document, when we refer to "Ops Manager", you may substitute "Cloud Manager". The functionality is the same.
 > If this is your first time trying the Operator, Cloud Manager is easier to get started 
 
 
-
 ## Installation
 
 ### Create Kubernetes Namespace
@@ -63,14 +64,19 @@ or clone this repo, make any edits you need, and apply it from your machine.
 
     kubectl apply -f mongodb-enterprise.yaml
 
+Check the end of the page for instructions on how to remove the Operator.
 
-### Helm Installation
+### Installation using Helm Chart
 
-If you have an Helm installation in your Kubernetes cluster, you can run:
+If you have installed the Helm client locally then you can run (note that `helm install` is a less preferred way as makes upgrades more complicated. 
+`kubectl apply` is a much clearer way of installing/upgrading):
 
-    helm install helm_chart/ --name mongodb-enterprise
+    helm template public/helm_chart > operator.yaml
+    kubectl apply -f operator.yaml
 
+You can customize installation by simple overriding of helm variables, for example use `--set operator.env="dev"` to run the Operator in development mode
 
+Check the end of the page for instructions on how to remove the Operator.
 
 ## Adding Ops Manager Credentials ##
 
@@ -142,8 +148,30 @@ users.
 
 ### Creating a MongoDB Object ###
 
-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`.
+A MongoDB object in Kubernetes can be a MongoDBStandalone, a MongoDBReplicaSet or a MongoDBShardedCluster (short names are `mst`, `mrs`, `msc`). 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
+    
+### Correct order of Operator/Namespace removal
+
+It's important to keep correct order or removal operations. The simple rule is: **never remove Operator before mongodb resources**!
+The reason is that, starting from version `0.6`, the Operator adds a finalizer header to each mongodb resource, preventing 
+them from removal until a controller removes this header. As the MongoDB Operator is the only controller that can do this, 
+removing it before removing the mongodb resources is an error.
+
+These are the correct steps to clean up any MongoDB Operator resources:
+
+```bash
+# these three operations must be called first!
+kubectl delete mst --all -n <namespace>
+kubectl delete mrs --all -n <namespace>
+kubectl delete msc --all -n <namespace>
+
+# any of the following commands must be called removing all existing mongodb resources
+kubectl delete namespace <namespace>
+kubectl delete deployment mongodb-enterprise-operator -n <namespace>
+kubectl delete crd --all
+```
+   

crds.yaml

@@ -1,4 +1,4 @@
-##---
+---
 # Source: mongodb-enterprise-operator/templates/crds.yaml
 
 
@@ -30,6 +30,14 @@ spec:
                   type: string
                 version:
                   type: string
+                logLevel:
+                  type: string
+                  enum:
+                  - DEBUG
+                  - INFO
+                  - WARN
+                  - ERROR
+                  - FATAL
           required:
           - credentials
           - project
@@ -67,6 +75,14 @@ spec:
                   type: string
                 version:
                   type: string
+                logLevel:
+                  type: string
+                  enum:
+                  - DEBUG
+                  - INFO
+                  - WARN
+                  - ERROR
+                  - FATAL
           required:
           - credentials
           - project
@@ -115,6 +131,14 @@ spec:
                   type: string
                 version:
                   type: string
+                logLevel:
+                  type: string
+                  enum:
+                  - DEBUG
+                  - INFO
+                  - WARN
+                  - ERROR
+                  - FATAL
           required:
           - credentials
           - project

helm_chart/templates/crds.yaml

@@ -28,6 +28,14 @@ spec:
                   type: string
                 version:
                   type: string
+                logLevel:
+                  type: string
+                  enum:
+                  - DEBUG
+                  - INFO
+                  - WARN
+                  - ERROR
+                  - FATAL
           required:
           - credentials
           - project
@@ -65,6 +73,14 @@ spec:
                   type: string
                 version:
                   type: string
+                logLevel:
+                  type: string
+                  enum:
+                  - DEBUG
+                  - INFO
+                  - WARN
+                  - ERROR
+                  - FATAL
           required:
           - credentials
           - project
@@ -113,6 +129,14 @@ spec:
                   type: string
                 version:
                   type: string
+                logLevel:
+                  type: string
+                  enum:
+                  - DEBUG
+                  - INFO
+                  - WARN
+                  - ERROR
+                  - FATAL
           required:
           - credentials
           - project

helm_chart/templates/operator.yaml

@@ -3,7 +3,9 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: {{ .Values.operator.name }}
+{{ if .Values.namespace }}
   namespace: {{ .Values.namespace }}
+{{ end }}
 spec:
   replicas: 1
   selector:
@@ -19,22 +21,38 @@ spec:
       - name: {{ .Values.operator.name }}
         image: {{ .Values.registry.repository }}/mongodb-enterprise-operator:{{ .Values.operator.version }}
         imagePullPolicy: {{ .Values.registry.pullPolicy }}
+{{ if .Values.registry.imagePullSecrets}}
+        imagePullSecrets:
+        - name: {{ .Values.registry.imagePullSecrets }}
+{{ end }}
         env:
         - name: OPERATOR_ENV
           value: {{ .Values.operator.env }}
         - name: WATCH_NAMESPACE
+{{ if .Values.operator.watchNamespace}}
+          value: "{{ .Values.operator.watchNamespace }}"
+{{ else }}
           valueFrom:
             fieldRef:
               fieldPath: metadata.namespace
+{{ end }}
 {{ if eq .Values.managedSecurityContext true}}
         - name: MANAGED_SECURITY_CONTEXT
           value: 'true'
-{{end}}
+{{ end }}
         - name: MONGODB_ENTERPRISE_DATABASE_IMAGE
           value: {{ .Values.registry.repository }}/mongodb-enterprise-database:{{ .Values.operator.version }}
         - name: IMAGE_PULL_POLICY
           value: {{ .Values.registry.pullPolicy }}
+{{ if .Values.registry.imagePullSecrets }}
         - name: IMAGE_PULL_SECRETS
           value: {{ .Values.registry.imagePullSecrets }}
-      imagePullSecrets: 
-      - name: {{ .Values.registry.imagePullSecrets }}
+{{ end }}
+{{ if .Values.operator.podWaitSeconds }}
+        - name: POD_WAIT_SEC
+          value: {{ quote .Values.operator.podWaitSeconds }}
+{{ end }}
+{{ if .Values.operator.podSetWaitRetries }}
+        - name: POD_WAIT_RETRIES
+          value: {{ quote .Values.operator.podSetWaitRetries }}
+{{ end }}

helm_chart/templates/roles.yaml

@@ -3,7 +3,9 @@ kind: Role
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: {{ .Values.operator.name }}
+{{ if .Values.namespace }}
   namespace: {{ .Values.namespace }}
+{{ end }}
 rules:
 - apiGroups:
   - ""
@@ -17,6 +19,7 @@ rules:
   - create
   - update
   - delete
+  - watch
 - apiGroups:
   - apps
   resources:
@@ -34,12 +37,16 @@ kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: {{ .Values.operator.name }}
+{{ if .Values.namespace }}
   namespace: {{ .Values.namespace }}
+{{ end }}
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: Role
   name: {{ .Values.operator.name }}
 subjects:
 - kind: ServiceAccount
   name: {{ .Values.operator.name }}
+{{ if .Values.namespace }}
   namespace: {{ .Values.namespace }}
+{{ end }}

helm_chart/templates/serviceaccount.yaml

@@ -3,4 +3,6 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: {{ .Values.operator.name }}
+{{ if .Values.namespace }}
   namespace: {{ .Values.namespace }}
+{{ end }}

helm_chart/values.yaml

@@ -16,7 +16,7 @@ operator:
   name: mongodb-enterprise-operator
 
   # Version of mongodb-enterprise-operator and mongodb-enterprise-database images
-  version: 0.5
+  version: 0.6
 
 registry:
   # Specify if images are pulled from private repository

mongodb-enterprise.yaml

@@ -1,11 +1,13 @@
-##---
+---
 # Source: mongodb-enterprise-operator/templates/roles.yaml
 ---
 kind: Role
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: mongodb-enterprise-operator
+
   namespace: mongodb
+
 rules:
 - apiGroups:
   - ""
@@ -19,6 +21,7 @@ rules:
   - create
   - update
   - delete
+  - watch
 - apiGroups:
   - apps
   resources:
@@ -36,31 +39,39 @@ kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
 metadata:
   name: mongodb-enterprise-operator
+
   namespace: mongodb
+
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: Role
   name: mongodb-enterprise-operator
 subjects:
 - kind: ServiceAccount
   name: mongodb-enterprise-operator
+
   namespace: mongodb
-##---
+
+---
 # Source: mongodb-enterprise-operator/templates/serviceaccount.yaml
 ---
 apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: mongodb-enterprise-operator
+
   namespace: mongodb
-##---
+
+---
 # Source: mongodb-enterprise-operator/templates/operator.yaml
 ---
 apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: mongodb-enterprise-operator
+
   namespace: mongodb
+
 spec:
   replicas: 1
   selector:
@@ -74,21 +85,23 @@ spec:
       serviceAccountName: mongodb-enterprise-operator
       containers:
       - name: mongodb-enterprise-operator
-        image: quay.io/mongodb/mongodb-enterprise-operator:0.5
+        image: quay.io/mongodb/mongodb-enterprise-operator:0.6
         imagePullPolicy: Always
+
         env:
         - name: OPERATOR_ENV
           value: prod
         - name: WATCH_NAMESPACE
+
           valueFrom:
             fieldRef:
               fieldPath: metadata.namespace
 
+
         - name: MONGODB_ENTERPRISE_DATABASE_IMAGE
-          value: quay.io/mongodb/mongodb-enterprise-database:0.5
+          value: quay.io/mongodb/mongodb-enterprise-database:0.6
         - name: IMAGE_PULL_POLICY
           value: Always
-        - name: IMAGE_PULL_SECRETS
-          value: 
-      imagePullSecrets: 
-      - name: 
+
+
+

samples/extended/replica-set.yaml

@@ -17,6 +17,9 @@ spec:
   project: my-project
   credentials: my-credentials
 
+  # log level affects the level of logging for the agent. Use DEBUG cautiously as log file size may grow very quickly
+  logLevel: WARN
+
   persistent: true
   podSpec:
     cpu: '0.25'