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
+38-33Lines changed: 38 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,39 @@ Please note that this project is currently in beta, and is not yet recommended f
6
6
7
7
You can discuss this integration in our [Slack](https://community-slack.mongodb.com) - join the [#enterprise-kubernetes](https://mongo-db.slack.com/messages/CB323LCG5/) channel.
[Known Issues for Kubernetes Operator](https://docs.opsmanager.mongodb.com/current/reference/known-issues-k8s-beta)
24
+
9
25
## Requirements ##
10
26
11
27
The MongoDB Enterprise Operator is compatible with Kubernetes v1.9 and above. It has been tested against Openshift 3.9.
12
28
13
-
This Operator requires Ops Manager or Cloud Manager. In this document, when we refer to "Ops Manager", Cloud Manager may also be used.
29
+
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.
30
+
31
+
32
+
33
+
## Installation install ##
34
+
35
+
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
This operator can also be installed using yaml files, in case you are not using Helm.
26
-
27
-
kubectl apply -f mongodb-enterprise.yaml
28
51
29
52
30
53
## Adding Ops Manager Credentials ##
@@ -36,13 +59,14 @@ For the Operator to work, you will need the following information:
36
59
* User - an Ops Manager username
37
60
* 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.
38
61
62
+
This is documented in greater detail in our [installation guide](https://docs.opsmanager.mongodb.com/current/tutorial/install-k8s-operator)
63
+
64
+
39
65
### Projects ###
40
66
41
67
A `Project` object is a Kubernetes `ConfigMap` that points to an Ops Manager installation and a `Project`. This `ConfigMap` has the following structure:
42
68
43
-
44
69
```
45
-
46
70
$ cat my-project.yaml
47
71
---
48
72
apiVersion: v1
@@ -51,8 +75,8 @@ metadata:
51
75
name: my-project
52
76
namespace: mongodb
53
77
data:
54
-
projectId: my-project-id
55
-
baseUrl: https://my-ops-cloud-manager-url
78
+
projectId: my-project-id # get this from Ops Manager
@@ -89,29 +113,10 @@ We can't see the contents of the `Secret`, because it is a secret!
89
113
This is good, it will allow us to maintain a separation between our
90
114
users.
91
115
92
-
### Creating MongoDB Object ###
93
-
94
-
A MongoDB object in Kubernetes can be a Standalone, a Replica Set or a Sharded Cluster. We are going to create a Replica Set to test that everything is working as expected. There is a ReplicaSet creation yaml file in the `samples/` directory. The contents of this file are as follows:
95
-
96
-
```yaml
97
-
---
98
-
apiVersion: mongodb.com/v1
99
-
kind: MongoDbReplicaSet
100
-
metadata:
101
-
name: my-replica-set
102
-
namespace: mongodb
103
-
spec:
104
-
members: 3
105
-
version: 3.6.5
106
-
107
-
persistent: false # For testing, create Pods with NO persistent volumes.
108
-
109
-
project: my-project
110
-
credentials: my-credentials
111
-
112
-
```
116
+
### Creating a MongoDB Object ###
113
117
114
-
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 now and a new Replica Set with 3 members should soon appear in Ops Manager UI.
118
+
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`.
115
119
120
+
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.
0 commit comments