You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-16Lines changed: 15 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ You can discuss this integration in our [Slack](https://community-slack.mongodb.
29
29
The MongoDB Enterprise Operator is compatible with Kubernetes v1.11 and above. It has been tested against Openshift 3.11.
30
30
31
31
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.
32
-
> If this is your first time trying the Operator, Cloud Manager is easier to get started
32
+
> If this is your first time trying the Operator, Cloud Manager is easier to get started
33
33
34
34
35
35
## Installation
@@ -39,20 +39,20 @@ This Operator requires [Ops Manager](https://docs.opsmanager.mongodb.com/current
39
39
The Mongodb Enterprise Operator is installed, by default, into the `mongodb` Namespace, but this Namespace is not created automatically. To create this Namespace you should execute:
40
40
41
41
kubectl create namespace mongodb
42
-
43
-
If you plan on using any other Namespace, please make sure you update the yaml files' `metadata.namespace` attribute to
44
-
point to your preferred Namespace. If using `helm` you need to override the `namespace` attribute with `--set namespace=<..>`
42
+
43
+
If you plan on using any other Namespace, please make sure you update the yaml files' `metadata.namespace` attribute to
44
+
point to your preferred Namespace. If using `helm` you need to override the `namespace` attribute with `--set namespace=<..>`
45
45
during helm installation
46
46
47
47
### Installation using yaml files
48
48
49
49
#### Create CustomResourceDefinitions
50
50
51
-
The `CustomResourceDefinition` (or `crd`) should be installed before installing the operator into your Kubernetes cluster. To do this, make sure you have logged into your Kubernetes cluster and that you can perform Cluster level operations:
51
+
The `CustomResourceDefinition` (or `crds`) should be installed before installing the operator into your Kubernetes cluster. To do this, make sure you have logged into your Kubernetes cluster and that you can perform Cluster level operations:
This will create one new `crd` in your cluster, `MongoDB`. This new object will be the one used by the operator to perform the MongoDb operations needed to prepare each one of the three different types of MongoDB deployments.`Standalone`, `ReplicaSet` and `ShardedCluster`
55
+
This will create a new `crd` in your cluster, `MongoDB`. This new object will be the one used by the operator to perform the MongoDb operations needed to prepare each one of the different MongoDb types of deployments.
56
56
57
57
#### Operator Installation
58
58
@@ -68,13 +68,13 @@ Check the end of the page for instructions on how to remove the Operator.
68
68
69
69
### Installation using Helm Chart
70
70
71
-
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.
71
+
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.
72
72
`kubectl apply` is a much clearer way of installing/upgrading):
73
73
74
-
helm template helm_chart > operator.yaml
74
+
helm template public/helm_chart > operator.yaml
75
75
kubectl apply -f operator.yaml
76
76
77
-
You can customize installation by simple overriding of helm variables, for example use `--set operator.env="dev"` to run the Operator in development mode
77
+
You can customize installation by simple overriding of helm variables, for example use `--set operator.env="dev"` to run the Operator in development mode
78
78
(this will turn logging level to `Debug` and will make logging output as non-json)
79
79
80
80
Check the end of the page for instructions on how to remove the Operator.
@@ -110,9 +110,9 @@ data:
110
110
orgId: 5b890e0feacf0b76ff3e7183 # this is an optional parameter
A MongoDB resource (short name `mdb`) in Kubernetes can have a type of Standalone, ReplicaSet or ShardedCluster. 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`.
130
+
A MongoDB object in Kubernetes is a MongoDB (short name `mdb`). We are going to create a replica set to test that everything is working as expected. There is a MongoDB replica set yaml file in `samples/minimal/replicaset.yaml`.
131
131
132
132
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.
133
133
134
134
kubectl apply -f samples/minimal/replicaset.yaml
135
-
135
+
136
136
### Correct order of Operator/Namespace removal
137
137
138
138
It's important to keep correct order or removal operations. The simple rule is: **never remove Operator before mongodb resources**!
139
-
The reason is that the Operator cleans state in Ops Manager on deletion of the MongoDB resource in Kubernetes.
139
+
The reason is that the Operator cleans state in Ops Manager on deletion of the MongoDB resource in Kubernetes.
140
140
141
141
These are the correct steps to remove any MongoDB Operator resources:
0 commit comments