Skip to content

Commit 44282e3

Browse files
(DOCSP-8007): adding notes for using ops manager with mdb outside of k8s (#188)
* (DOCSP-8007): adding notes for using ops manager with mdb outside of k8s * (DOCSP-8007): copy review feedback * (DOCSP-8007): added tutorial per tech review feedback * (DOCSP-8007): tech review feedback
1 parent ad397a4 commit 44282e3

File tree

6 files changed

+71
-1
lines changed

6 files changed

+71
-1
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. important::
2+
3+
If you deploy |onprem| with the |k8s-op-short| and |onprem| will
4+
manage MongoDB database resources deployed outside of the |k8s|
5+
cluster it's deployed to, you must set ``data.baseUrl`` to the same
6+
value of the
7+
:opsmgrkube:`spec.configuration.mms.centralUrl <spec.configuration>`
8+
setting in the |onprem| resource specification.
9+
10+
.. seealso:: :ref:`mdb-resource-deployment-locations`
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. important::
2+
3+
If |onprem| will manage MongoDB resources deployed outside of the
4+
|k8s| cluster it's deployed to, you must add the ``mms.centralUrl``
5+
setting to ``spec.configuration``.
6+
7+
Set the value to the URL by which |onprem| is exposed outside of the
8+
|k8s| cluster.
9+
10+
.. seealso:: :ref:`mdb-resource-deployment-locations`

source/includes/list-tables/configmap-keys.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,11 @@
8686
- |url| to your |application| including the |fqdn| and port
8787
number.
8888

89+
.. include:: /includes/admonitions/data-url-config-map-external-dbs.rst
90+
8991
.. note::
9092

91-
You may use |cloud-short| for the ``data.baseUrl`` value.
93+
If you're using |cloud-short|, set the ``data.baseUrl`` value
94+
to ``https://cloud.mongodb.com``.
9295

9396
- ``https://ops.example.com:8443``

source/includes/steps-deploy-k8s-opsmgr.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,9 @@ content: |
257257
258258
- ``spec.``:opsmgrkube:`~spec.clusterDomain`
259259
- ``spec.``:opsmgrkube:`~spec.configuration`
260+
261+
.. include:: /includes/admonitions/mms-centralurl-external-mdb.rst
262+
260263
- ``spec.applicationDatabase.``:setting:`~spec.logLevel`
261264
- ``spec.applicationDatabase.``:setting:`~spec.featureCompatibilityVersion`
262265
- ``spec.applicationDatabase.podSpec.``:setting:`~spec.podSpec.cpu`
@@ -470,6 +473,8 @@ content: |
470473
url: http://om-svc.dev.svc.cluster.local:8080
471474
version: ""
472475
476+
.. include:: /includes/admonitions/data-url-config-map-external-dbs.rst
477+
473478
---
474479
title: "Deploy MongoDB database resources to complete the Backup configuration."
475480
stepnum: 12

source/reference/k8s-operator-om-specification.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,8 @@ Optional |onprem| Resource Settings
401401
</reference/configuration/>` for property names and descriptions.
402402
Each property takes a value of type ``string``.
403403

404+
.. include:: /includes/admonitions/mms-centralurl-external-mdb.rst
405+
404406
.. opsmgrkube:: spec.externalConnectivity
405407

406408
*Type*: collection

source/tutorial/plan-om-resource.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,46 @@ to create a service:
224224
- ``spec.``:opsmgrkube:`~spec.externalConnectivity`
225225
- ``spec.externalConnectivity.``:opsmgrkube:`~spec.externalConnectivity.type`
226226

227+
.. _mdb-resource-deployment-locations:
228+
229+
Managing External MongoDB Deployments
230+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
231+
232+
When you deploy |onprem| with the |k8s-op-short|, |onprem| can manage
233+
MongoDB database resources deployed:
234+
235+
- To the same |k8s| cluster as |onprem|.
236+
- Outside of |k8s| clusters.
237+
238+
If |onprem| will manage MongoDB database resources deployed to different
239+
|k8s| clusters than |onprem| or outside of |k8s| clusters, you must:
240+
241+
1. Add the ``mms.centralUrl`` setting to ``spec.configuration`` in the
242+
|onprem| resource specification.
243+
244+
Set the value to the URL by which |onprem| is exposed outside of the
245+
|k8s| cluster:
246+
247+
.. code-block:: yaml
248+
249+
spec:
250+
configuration:
251+
mms.centralUrl: https://a9a8f8566e0094380b5c257746627b82-1037623671.us-east-1.elb.example.com:8080/
252+
253+
#. :ref:`Update the ConfigMaps <example-k8s-configmap>` referenced by
254+
all MongoDB database resources inside the |k8s| cluster that you
255+
deployed with the |k8s-op-short|.
256+
257+
Set ``data.baseUrl`` to the same value of the
258+
:opsmgrkube:`spec.configuration.mms.centralUrl <spec.configuration>`
259+
setting in the |onprem| resource specification.
260+
261+
.. important::
262+
263+
This includes the ConfigMaps that the `MongoDB database resources
264+
for the oplog and snapshot stores reference
265+
<../tutorial/deploy-om-container.html#deploy-mongodb-database-resources-to-complete-the-backup-configuration>`__.
266+
227267
.. _om-rsrc-prereqs:
228268

229269
Prerequisites

0 commit comments

Comments
 (0)