Skip to content

Commit f647c9f

Browse files
authored
(DOCSP-33645) Adds limitation for kmip configuration. (#1483)
* (DOCSP-33645) Adds limitation for kmip configuration. * Revises per tech review. * Revises per copy review. * Revises per tech review. * Adds high-level steps for KMIP workaround.
1 parent f92b79b commit f647c9f

File tree

4 files changed

+55
-1
lines changed

4 files changed

+55
-1
lines changed

source/multi-cluster-arch.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@ The following limitations exist for |multi-clusters|:
5353

5454
- Use only |k8s| |k8s-secrets| for your secret storage tool. The |hashicorp-vault|
5555
secret storage tool isn't supported.
56+
- For deployments where the same |k8s-op-short| instance is not managing both the
57+
:ref:`MongoDBOpsManager <k8s-om-specification>` and
58+
:ref:`MongoDB <k8s-specification>` custom resources,
59+
you must manually configure |kmip| backup encryption client settings in |onprem|.
60+
To learn more, see :ref:`kmip-workaround`.
5661
- Don't add a :github:`ServiceMonitor</prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md#related-resources>`
5762
to your |mongodb-multis|. The |k8s-op-short| doesn't support integration with Prometheus.
5863

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@ Configure KMIP Backup Encryption for Ops Manager
1010
configure |kmip| backup encryption for |mms|. To learn more, see
1111
:opsmgr:`Encrypted Backup Snapshots </tutorial/encrypt-snapshots/>`.
1212

13+
.. _kmip-limitations:
14+
15+
Limitations
16+
-----------
17+
18+
For deployments where the same |k8s-op-short| instance is not managing both the
19+
:ref:`MongoDBOpsManager <k8s-om-specification>` and
20+
:ref:`MongoDB <k8s-specification>` custom resources,
21+
you must manually configure |kmip|
22+
backup encryption client settings in the
23+
:ref:`MongoDBOpsManager <k8s-om-specification>` custom resource.
24+
This requirement involves including client certificates for each MongoDB database,
25+
which you can achieve by overriding the |onprem| Pod's StatefulSet to mount
26+
the certificates. To learn more, see :ref:`kmip-workaround`.
27+
1328
Procedure
1429
---------
1530

source/tutorial/om-arch.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,12 @@ If you enable backup, you must provide additional fields in the
135135
:opsmgrkube:`spec.backup <spec.backup.enabled>` collection to configure:
136136
the :term:`oplog store <oplog store database>` and a :term:`blockstore
137137
<Backup Blockstore Database>` or an |s3| :term:`snapshot store <S3
138-
Snapshot Store>`.
138+
Snapshot Store>`. You can also
139+
:ref:`encrypt backup jobs <configure-kmip-backup-encryption>`, but
140+
:ref:`limitations <kmip-limitations>` apply to deployments where the same
141+
|k8s-op-short| instance is not managing both the
142+
:ref:`MongoDBOpsManager <k8s-om-specification>` and :ref:`MongoDB <k8s-specification>`
143+
custom resources.
139144

140145
If you enable backup, the |k8s-op-short| creates a |k8s-pvc| for the
141146
Backup Daemon's :term:`head database`. You can

source/tutorial/plan-om-resource.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,12 @@ enable the Backup Daemon and configure the head database.
199199
to use for Backup at random.
200200

201201
The |onprem| resource remains in a ``Pending`` state until you configure these Backup resources.
202+
203+
You can also :ref:`encrypt backup jobs <configure-kmip-backup-encryption>`, but
204+
:ref:`limitations <kmip-limitations>` apply to deployments where the same
205+
|k8s-op-short| instance is not managing both the
206+
:ref:`MongoDBOpsManager <k8s-om-specification>` and :ref:`MongoDB <k8s-specification>`
207+
custom resources.
202208

203209
Oplog Store
204210
+++++++++++
@@ -271,6 +277,29 @@ To disable backup after you enabled it:
271277
To learn about reclaiming |k8s-pvs|, see the
272278
:k8sdocs:`Kubernetes documentation </concepts/storage/persistent-volumes/#reclaiming>`.
273279

280+
.. _kmip-workaround:
281+
282+
Manually Configure KMIP Backup Encryption
283+
+++++++++++++++++++++++++++++++++++++++++
284+
285+
For deployments where the same |k8s-op-short| instance is *not* managing both the
286+
:ref:`MongoDBOpsManager <k8s-om-specification>` and
287+
:ref:`MongoDB <k8s-specification>` custom resources,
288+
you must manually configure |kmip| backup encryption client settings in |onprem|
289+
using the following procedure. If the |k8s-op-short| *is* managing both resources,
290+
see :ref:`configure-kmip-backup-encryption` instead.
291+
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+
297+
2. Mount the |kmip| client certificates to |onprem| by overriding the
298+
|k8s-statefulset|.
299+
300+
3. Configure the |kmip| settings for your project in |onprem|. To learn more,
301+
see :ref:`configure-group-kmip`.
302+
274303
.. _config-https:
275304

276305
Configure |onprem| to Run over HTTPS

0 commit comments

Comments
 (0)