Skip to content

Commit 3f87eb8

Browse files
authored
(DOCSP-34619) Updates workaround with POC steps. (#1527)
* (DOCSP-34619) Updates workaround with POC steps. * Revises per tech review.
1 parent b947a78 commit 3f87eb8

File tree

3 files changed

+43
-12
lines changed

3 files changed

+43
-12
lines changed

source/multi-cluster-arch.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The following limitations exist for |multi-clusters|:
5656
:ref:`MongoDBOpsManager <k8s-om-specification>` and
5757
:ref:`MongoDB <k8s-specification>` custom resources,
5858
you must manually configure |kmip| backup encryption client settings in |onprem|.
59-
To learn more, see :ref:`kmip-workaround`.
59+
To learn more, see :ref:`kmip-manual-procedure`.
6060
- Don't add a :github:`ServiceMonitor</prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md#related-resources>`
6161
to your |mongodb-multis|. The |k8s-op-short| doesn't support integration with Prometheus.
6262

source/tutorial/configure-kmip-backup-encryption.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ For deployments where the same |k8s-op-short| instance is not managing both the
2020
:ref:`MongoDB <k8s-specification>` custom resources,
2121
you must manually configure |kmip|
2222
backup encryption client settings in the
23-
:ref:`MongoDBOpsManager <k8s-om-specification>` custom resource.
23+
:ref:`MongoDBOpsManager <k8s-om-specification>` custom resource.
2424
This requirement involves including client certificates for each MongoDB database,
2525
which you can achieve by overriding the |onprem| Pod's StatefulSet to mount
26-
the certificates. To learn more, see :ref:`kmip-workaround`.
26+
the certificates. To learn more, see :ref:`kmip-manual-procedure`.
2727

2828
Procedure
2929
---------

source/tutorial/plan-om-resource.txt

Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Plan Your Ops Manager Resource
66

77
.. default-domain:: mongodb
88

9+
.. facet::
10+
:name: genre
11+
:values: reference
12+
913
.. contents:: On this page
1014
:local:
1115
:backlinks: none
@@ -277,7 +281,7 @@ To disable backup after you enabled it:
277281
To learn about reclaiming |k8s-pvs|, see the
278282
:k8sdocs:`Kubernetes documentation </concepts/storage/persistent-volumes/#reclaiming>`.
279283

280-
.. _kmip-workaround:
284+
.. _kmip-manual-procedure:
281285

282286
Manually Configure KMIP Backup Encryption
283287
+++++++++++++++++++++++++++++++++++++++++
@@ -289,16 +293,43 @@ you must manually configure |kmip| backup encryption client settings in |onprem|
289293
using the following procedure. If the |k8s-op-short| *is* managing both resources,
290294
see :ref:`configure-kmip-backup-encryption` instead.
291295

292-
1. Get the absolute path to the |kmip| client certificate for each MongoDB
293-
:ref:`project <projects-page-admin-ui>` in your deployment. All deployments
294-
in the project use the same |kmip| client certificate file to authenticate
295-
to the |kmip| server.
296+
Prerequisites
297+
#############
298+
299+
- A running |kmip| server.
300+
- A running |onprem| instance, `configured to use KMIP <https://www.mongodb.com/docs/kubernetes-operator/master/tutorial/configure-kmip-backup-encryption/#configure-the-onprem-custom-resource-to-use-kmip-backup-encryption>`__.
301+
- A |tls| secret that :ref:`concatenates the private key and the KMIP client certificate in PEM format <client-cert-kmip>`.
302+
303+
Procedure
304+
#########
296305

297-
2. Mount the |kmip| client certificates to |onprem| by overriding the
298-
|k8s-statefulset|.
306+
1. Mount the |tls| secret to the :ref:`MongoDBOpsManager <k8s-om-specification>` custom resource. For example:
307+
308+
.. code-block:: yaml
309+
310+
apiVersion: mongodb.com/v1
311+
kind: MongoDBOpsManager
312+
metadata:
313+
name: ops-manager-pod-spec
314+
spec:
315+
< ... omitted ... >
316+
statefulSet:
317+
spec:
318+
template:
319+
spec:
320+
volumes:
321+
- name: kmip-client-test-prefix-mdb-latest-kmip-client
322+
secretName: test-prefix-mdb-latest-kmip-client
323+
containers:
324+
- name: mongodb-ops-manager
325+
volumeMounts:
326+
- mountPath: /mongodb-ops-manager/kmip/client/test-prefix-mdb-latest-kmip-client
327+
name: kmip-client-test-prefix-mdb-latest-kmip-client
328+
readOnly: true
329+
...
299330

300-
3. Configure the |kmip| settings for your project in |onprem|. To learn more,
301-
see :ref:`configure-group-kmip`.
331+
2. Configure the |kmip| settings for your project in |onprem| following the procedure
332+
in :ref:`configure-group-kmip`.
302333

303334
.. _config-https:
304335

0 commit comments

Comments
 (0)