Skip to content

Commit 1c17992

Browse files
Anthony Sansonejwilliams-mongo
authored andcommitted
(DOCSP-5015): Added Cloud Manager note to Install.
1 parent 24b008d commit 1c17992

File tree

5 files changed

+28
-15
lines changed

5 files changed

+28
-15
lines changed

conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
'.. |certauth| replace:: Certificate Authority',
8181
'.. |cidr| replace:: :abbr:`CIDR (Classless Inter-Domain Routing)`',
8282
'.. |cifs| replace:: :abbr:`CIFS (Common Internet File System)`',
83+
'.. |com| replace:: Cloud Manager or Ops Manager',
8384
'.. |dns| replace:: :abbr:`DNS (Domain Name System)`',
8485
'.. |dns-srv| replace:: :abbr:`DNS (Domain Name System)` :abbr:`SRV (Service)`',
8586
'.. |ent-build| replace:: MongoDB Enterprise',
@@ -181,6 +182,8 @@
181182
'issue': ('https://jira.mongodb.org/browse/%s', '' ),
182183
'manual': ('http://docs.mongodb.com/manual%s', ''),
183184
'opsmgr': ('http://docs.opsmanager.mongodb.com/current%s', ''),
185+
'cloudmgr': ('http://docs.cloudmanager.mongodb.com/%s', ''),
186+
'atlas': ('http://docs.atlas.mongodb.com/%s', ''),
184187
'bic': ('https://docs.mongodb.com/bi-connector/current%s',''),
185188
'product': ('http://www.mongodb.com/products/%s?jmp=docs',''),
186189
'dl': ('http://www.mongodb.com/download-center/%s?jmp=docs','')
Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
.. admonition:: Added in |onprem| 4.0
1+
.. admonition:: Supported in Cloud Manager and |onprem| 4.0
22
:class: note
33

4-
You can use |k8s| to deploy MongoDB instances with
5-
|onprem| version 4.0 or later.
4+
You can use |k8s-op-short| to deploy MongoDB instances with
5+
|onprem| version 4.0 or later and Cloud Manager. At any place in
6+
this guide that says *Ops Manager*, you can substitute
7+
*Cloud Manager*. You cannot use the
8+
Operator to deploy MongoDB instances in :atlas:`MongoDB Atlas </>`.

source/includes/options-k8s-shared.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ optional: true
8282
default: cluster.local
8383
description: |
8484
When |k8s| creates a |k8s-statefulset|, the
85-
|k8s| assigns each |k8s-pod| a |fqdn|. To update |onprem|, the
85+
|k8s| assigns each |k8s-pod| a |fqdn|. To update |com|, the
8686
|k8s-op-short| calculates the |fqdn| for each |k8s-pod|
8787
using a provided clusterName. |k8s| does not provide an |api| to
8888
query these hostnames.
@@ -94,14 +94,14 @@ type: string
9494
directive: setting
9595
optional: false
9696
description: |
97-
*Required.* Name of the |k8s-configmap| with the |onprem| connection
97+
*Required.* Name of the |k8s-configmap| with the |com| connection
9898
configuration.
9999
100100
.. admonition:: Value must match namespace and name of ConfigMap
101101
:class: note
102102
103103
This value *must* match the value you provided for
104-
:setting:`metadata.name` in your |onprem|
104+
:setting:`metadata.name` in your |com|
105105
:ref:`project ConfigMap <create-k8s-project>`.
106106
107107
If this |k8s-mdbrsc| is in a different |k8s-ns| than the
@@ -122,7 +122,7 @@ description: |
122122
123123
*Required.* Name of the |k8s| |k8s-secret| you :ref:`created
124124
<create-k8s-secret>` as |mms| |api| authentication credentials for
125-
the |k8s-op-short| to communicate with |onprem|.
125+
the |k8s-op-short| to communicate with |com|.
126126
127127
.. admonition:: Value must use namespace and name of Secret
128128
:class: note

source/index.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,22 @@ The |k8s-op-full| enables `Kubernetes <https://kubernetes.io/>`__ to
1818
manage typical lifecycle events for MongoDB that have strict policies
1919
on data persistence and management. The Operator handles the creation
2020
of MongoDB enterprise pods, coordinates configuration of MongoDB
21-
deployments with |onprem-link|, and orchestrates MongoDB configuration
21+
deployments with |com|, and orchestrates MongoDB configuration
2222
changes -- accomplished through the Kubernetes |api|, declarative
2323
configuration in |yaml|, or other tooling.
2424

25-
The |k8s-op-full| works together with MongoDB |onprem|, which applies
25+
The |k8s-op-full| works together with MongoDB |com|, which applies
2626
final configurations to MongoDB clusters. When MongoDB is deployed and
2727
running in Kubernetes, there are a number of tasks that may not relate
2828
to Kubernetes operations. You can manage these tasks -- monitoring,
2929
fine tuning database performance, database backups, index management,
30-
etc. -- in |onprem|.
30+
etc. -- in |com|.
3131

3232
The Kubernetes CustomResourceDefinitions allow administrators to
3333
configure resource types and access permissions in Kubernetes.
3434
Developers deploy the MongoDB database in the same way as they deploy
3535
the rest of the application services. DBAs can work within the familiar
36-
|onprem| interface to help run MongoDB at optimal performance.
36+
|com| interface to help run MongoDB at optimal performance.
3737

3838
.. class:: hidden
3939

source/tutorial/install-k8s-operator.txt

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=====================
2-
Install |k8s-op-full|
3-
=====================
1+
===================================
2+
Install MongoDB Kubernetes Operator
3+
===================================
44

55
.. default-domain:: mongodb
66

@@ -444,6 +444,13 @@ the ConfigMap:
444444
role to create a new project
445445
*within an existing organization*.
446446

447+
.. admonition:: Limited to Cloud or Ops Manager Organizations
448+
449+
If you set this value, it can be for a Cloud Manager or
450+
an Ops Manager organization only. If you try to use an
451+
Atlas organization, the |k8s-op-short| may not work as
452+
intended.
453+
447454
- | ``https://ops.example.com:8443/``
448455
| ``v2#/org/<orgId>/projects``
449456

@@ -741,4 +748,4 @@ Troubleshooting
741748

742749
To troubleshoot your |k8s-op-short|, see :ref:`review-k8s-op-logs`.
743750

744-
.. include:: /includes/fact-remove-k8s-resources-first.rst
751+
.. include:: /includes/fact-remove-k8s-resources-first.rst

0 commit comments

Comments
 (0)