Skip to content

Commit 41b0c4f

Browse files
author
Anton Lisovenko
committed
5f2f307a51ca6c179ebba3388c8eb940f63a0a91: update public repo contents
1 parent 86614fa commit 41b0c4f

38 files changed

+749
-897
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### All Submissions:
22

3-
* [ ] Have you opened an Issue before filing this PR?
4-
* [ ] Have you signed our [CLA](https://www.mongodb.com/legal/contributor-agreement)?
3+
* [ ] Have you opened an Issue before filing this PR?
4+
* [ ] Have you signed our [CLA](https://www.mongodb.com/legal/contributor-agreement)?
55
* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?
66
* [ ] Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
77

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
Welcome to the MongoDB Enterprise Kubernetes Operator. The Operator enables easy deploys of MongoDB into Kubernetes clusters, using our management, monitoring and backup platforms, Ops Manager and Cloud Manager. By installing this integration, you will be able to deploy MongoDB instances with a single simple command.
44

5-
Also the Operator allows to deploy Ops Manager into Kubernetes. Note, that currently this feature is **beta**. See more information below.
5+
The Operator is currently Generally Available, supported by the [MongoDB Support Team](https://support.mongodb.com/). If you need urgent help, please file a support ticket.
6+
For non-urgent requests, you may file a Github Issue here in the repo.
67

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.
8+
As of recent releases, the Operator allows you to deploy Ops Manager into Kubernetes. This feature is in **beta**. For more information, see below.
9+
10+
You can discuss this integration in our new [Community Forum](https://community.mongodb.com/) - please use the tag [enterprise-kubernetes-operator](https://community.mongodb.com/tags/enterprise-kubernetes-operator).
811

912
## Documentation ##
1013

@@ -91,19 +94,19 @@ Check the end of the page for instructions on how to remove the Operator.
9194
For the Operator to work, you will need the following information:
9295

9396
* Base URL - the URL of an Ops Manager instance (for Cloud Manager use `https://cloud.mongodb.com`)
94-
* (optionally) Project Name - the name of an Ops Manager Project where MongoDBs will be deployed into. It will be
95-
created by the Operator if it doesn't exist (and this is the recommended way instead of reusing the project created
97+
* (optionally) Project Name - the name of an Ops Manager Project where MongoDBs will be deployed into. It will be
98+
created by the Operator if it doesn't exist (and this is the recommended way instead of reusing the project created
9699
in OpsManager directly). If omitted the name of the MongoDB resource will be used as a project name.
97100
* (optionally) Organization ID - the ID of the organization which the Project belongs to. The Operator will create
98101
an Organization with the same name as the Project if Organization ID is omitted.
99102
* API Credentials. This can be any pair of:
100-
* Public and Private Programmatic API keys. They correspond to `user` and `publicApiKey` fields in the Secret storing
101-
credentials. More information about the way to create them using Ops Manager UI can be found
103+
* Public and Private Programmatic API keys. They correspond to `user` and `publicApiKey` fields in the Secret storing
104+
credentials. More information about the way to create them using Ops Manager UI can be found
102105
[here](https://docs.opsmanager.mongodb.com/current/tutorial/configure-public-api-access/#programmatic-api-keys)
103106
* Username and Public API key. More information about the way to create them using Ops Manager UI can be found
104107
[here](https://docs.opsmanager.mongodb.com/current/tutorial/configure-public-api-access/#personal-api-keys-deprecated)
105108

106-
Note that you must whitelist the IP
109+
Note that you must whitelist the IP
107110
range of your Kubernetes cluster so that the Operator could make API requests to Ops Manager
108111

109112
This is documented in greater detail in our [installation guide](https://docs.opsmanager.mongodb.com/current/tutorial/install-k8s-operator)
@@ -136,7 +139,7 @@ Apply this file to create the new `Project`:
136139

137140
### Credentials ###
138141

139-
For a user to be able to create or update objects in this Ops Manager Project they need either a Public API Key or a
142+
For a user to be able to create or update objects in this Ops Manager Project they need either a Public API Key or a
140143
Programmatic API Key. These will be held by Kubernetes as a `Secret` object. You can create this Secret with the following command:
141144

142145
``` bash
@@ -207,3 +210,9 @@ kubectl delete namespace <namespace>
207210
kubectl delete deployment mongodb-enterprise-operator -n <namespace>
208211
kubectl delete crd/mongodb.mongodb.com
209212
```
213+
214+
## Contributing
215+
216+
Please file issues before filing PRs. For PRs to be accepted, contributors must sign our [CLA](https://www.mongodb.com/legal/contributor-agreement).
217+
218+
Reviewers, please ensure that the CLA has been signed by referring to [the contributors tool](https://contributors.corp.mongodb.com/) (internal link).

0 commit comments

Comments
 (0)