Skip to content

Commit a3c4924

Browse files
(DOCSP-8046): add externalconnectivity to opsmgr sample (#166)
* (DOCSP-8046): add externalconnectivity to opsmgr sample * (DOCSP-8046): copy review feedback * (DOCSP-8046): tech review feedback
1 parent 125387c commit a3c4924

File tree

3 files changed

+62
-48
lines changed

3 files changed

+62
-48
lines changed

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

Lines changed: 32 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ content: |
1111
.. literalinclude:: /reference/k8s/example-opsmgr-minimal.yaml
1212
:language: yaml
1313
:linenos:
14-
:emphasize-lines: 5,7-11,13,15,17-19,21,23-25,27-31,34-35
14+
:emphasize-lines: 5,7-11,13,15,17-19,21,23-25,27-31,34,38-39
1515
1616
---
1717
title: "Open your preferred text editor and paste the |k8s-obj| specification into a new text file."
@@ -152,6 +152,26 @@ content: |
152152
database Backup snapshots.
153153
- my-bucket
154154
155+
* - | ``spec``
156+
| ``.externalConnectivity``
157+
| ``.``:opsmgrkube:`~spec.externalConnectivity.type`
158+
- string
159+
- *Optional*.
160+
161+
The |k8s| service :k8sdocs:`ServiceType
162+
</concepts/services-networking/service/#publishing-services-service-types>`
163+
that exposes |onprem| outside of |k8s|.
164+
165+
.. note::
166+
167+
Exclude the ``spec.``:opsmgrkube:`~spec.externalConnectivity`
168+
setting and its children if you don't want the
169+
|k8s-op-short| to create a |k8s| service to route external
170+
traffic to the |onprem| application.
171+
172+
173+
- ``LoadBalancer``
174+
155175
* - | ``spec``
156176
| ``.applicationDatabase``
157177
| ``.``:setting:`~spec.members`
@@ -214,48 +234,10 @@ content: |
214234
.. include:: /includes/k8s/k8s-persistent-volumes-om.rst
215235
216236
- ``true``
217-
---
218-
title: "Allow external traffic to reach the |onprem| application."
219-
stepnum: 4
220-
level: 4
221-
ref: om-external-connectivity
222-
content: |
223-
224-
By default, the |k8s-op-short| does not create a |k8s| service to
225-
route traffic originating from outside of the |k8s| cluster to the
226-
|onprem| application.
227-
228-
To access the |onprem| application, you can:
229-
230-
- Configure the |k8s-op-short| to create a |k8s| service.
231-
- Create a |k8s| service manually. MongoDB recommends using a
232-
``LoadBalancer`` |k8s| service if your cloud provider supports it.
233-
- If you're using OpenShift, use
234-
`Routes <https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html>`__.
235-
- Use a third-party service, such as Istio.
236-
237-
The simplest method is to configure the |k8s-op-short| to create a
238-
|k8s| service to route external traffic to the |onprem| application:
239-
240-
a. Add the ``spec.``:opsmgrkube:`~spec.externalConnectivity` setting
241-
to the |k8s-obj| specification.
242-
243-
#. Add the following settings to the |k8s-obj| specification
244-
to configure the |k8s| service that routes external traffic to the
245-
|onprem| application:
246-
247-
- ``spec.externalConnectivity.``:opsmgrkube:`~spec.externalConnectivity.type`
248-
- (optional) ``spec.externalConnectivity.``:opsmgrkube:`~spec.externalConnectivity.port`
249-
250-
To learn how to create a |k8s| :k8sdocs:`service </concepts/services-networking/service/>`
251-
manually, see the |k8s| documentation.
252-
253-
To learn how to route external traffic to the |onprem| application
254-
using a different method, refer to the documentation for your solution.
255237
256238
---
257239
title: "(Optional) Configure any additional settings for an |onprem| deployment."
258-
stepnum: 5
240+
stepnum: 4
259241
level: 4
260242
ref: add-k8s-values
261243
content: |
@@ -286,16 +268,20 @@ content: |
286268
- ``spec.backup.opLogStores.mongodbUserRef.``:opsmgrkube:`~spec.backup.opLogStores.mongodbUserRef.name`
287269
- ``spec.backup.s3Stores.mongodbUserRef.``:opsmgrkube:`~spec.backup.s3Stores.mongodbUserRef.name`
288270
- ``spec.backup.s3Stores.``:opsmgrkube:`~spec.backup.s3Stores.pathStyleAccessEnabled`
271+
- ``spec.externalConnectivity.``:opsmgrkube:`~spec.externalConnectivity.port`
272+
- ``spec.externalConnectivity.``:opsmgrkube:`~spec.externalConnectivity.loadBalancerIP`
273+
- ``spec.externalConnectivity.``:opsmgrkube:`~spec.externalConnectivity.externalTrafficPolicy`
274+
- ``spec.externalConnectivity.``:opsmgrkube:`~spec.externalConnectivity.annotations`
289275
290276
---
291277
title: "Save this file with a ``.yaml`` file extension."
292-
stepnum: 6
278+
stepnum: 5
293279
level: 4
294280
ref: save-object-spec
295281

296282
---
297283
title: "Create your |onprem| instance."
298-
stepnum: 7
284+
stepnum: 6
299285
level: 4
300286
ref: start-k8s-instance
301287
content: |
@@ -309,7 +295,7 @@ content: |
309295
310296
---
311297
title: "Track the status of your |onprem| instance."
312-
stepnum: 8
298+
stepnum: 7
313299
level: 4
314300
ref: track-k8s-instance
315301
content: |
@@ -372,7 +358,7 @@ content: |
372358
373359
---
374360
title: "Access the |onprem| application."
375-
stepnum: 9
361+
stepnum: 8
376362
level: 4
377363
ref: access-opsmgr-instance
378364
content: |
@@ -422,8 +408,8 @@ content: |
422408
423409
#. Log in to |onprem| using the :ref:`admin user credentials <om-rsrc-prereqs>`.
424410
425-
To learn how to access the |onprem| application using a different
426-
traffic routing method, refer to the documentation for your solution.
411+
To learn how to access the |onprem| application using a third-party
412+
service, refer to the documentation for your solution.
427413
428414
---
429415
title: "Create credentials for the Kubernetes Operator."

source/reference/k8s/example-opsmgr-minimal.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ spec:
3030
s3BucketEndpoint: <s3.region.amazonaws.com>
3131
s3BucketName: <bucketname>
3232

33+
externalConnectivity:
34+
type: LoadBalancer
35+
3336
applicationDatabase:
3437
members: 3
3538
version: <mongodbversion>

source/tutorial/deploy-om-container.txt

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Prerequisites
2727

2828
To deploy an |onprem| resource you must:
2929

30-
1. :doc:`Install </tutorial/install-k8s-operator>` the |k8s-op| 1.3.0
30+
1. :doc:`Install </tutorial/install-k8s-operator>` the |k8s-op| 1.4.1
3131
or newer.
3232

3333
#. Ensure that the host on which you want to deploy |onprem| has a
@@ -225,7 +225,32 @@ To configure an |s3| :opsmgr:`snapshot store
225225

226226
You can update any additional |s3| :opsmgr:`configuration settings
227227
</tutorial/manage-s3-blockstore-storage/#provide-the-s3-blockstore-details>`
228-
that are not managed by the |k8s-op-short| through the |application|.
228+
that are not managed by the |k8s-op-short| through the |application|.
229+
230+
Ops Manager Application Access
231+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
232+
233+
By default, the |k8s-op-short| does not create a |k8s| service to route
234+
traffic originating from outside of the |k8s| cluster to the |onprem|
235+
application.
236+
237+
To access the |onprem| application, you can:
238+
239+
- Configure the |k8s-op-short| to create a |k8s| service.
240+
- Create a |k8s| service manually. MongoDB recommends using a
241+
``LoadBalancer`` |k8s| service if your cloud provider supports it.
242+
- If you're using OpenShift, use
243+
`routes <https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html>`__.
244+
- Use a third-party service, such as Istio.
245+
246+
The simplest method is configuring the |k8s-op-short| to create a |k8s|
247+
service that routes external traffic to the |onprem| application. The
248+
|onprem| deployment procedure instructs you to add the following
249+
settings to the |k8s-obj| specification that configures the |k8s-op-short|
250+
to create a service:
251+
252+
- ``spec.``:opsmgrkube:`~spec.externalConnectivity`
253+
- ``spec.externalConnectivity.``:opsmgrkube:`~spec.externalConnectivity.type`
229254

230255
Procedure
231256
---------

0 commit comments

Comments
 (0)