Skip to content

Commit 397d113

Browse files
erabil-mdbjwilliams-mongo
authored andcommitted
(DOCSP-33249) Adds topic for verifying MongoDB signatures. (#1624)
* (DOCSP-33249) Adds topic for verifying MongoDB signatures. * Revises per feedback from Nam.
1 parent ab65629 commit 397d113

File tree

3 files changed

+113
-0
lines changed

3 files changed

+113
-0
lines changed

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -922,6 +922,18 @@ Optional |onprem| Resource Settings
922922

923923
.. include:: /includes/admonitions/mms-centralurl-external-mdb.rst
924924

925+
.. opsmgrkube:: spec.configuration.mms.featureFlag.automation.verifyDownloads
926+
927+
*Type*: string
928+
929+
When set to ``enabled``, the {+mdbagent+} requires signature files
930+
for all MongoDB deployments that your |onprem| instance manages.
931+
932+
When you upgrade the {+mdbagent+} with this option enabled, the current version
933+
of the {+mdbagent+} requires signature files of the new {+mdbagent+} binary.
934+
935+
To learn more, see :ref:`k8s-signatures`.
936+
925937
.. opsmgrkube:: spec.configuration.mms.mongoDbUsage.defaultUsageType
926938

927939
*Type*: string

source/security.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ to secure your MongoDB deployments.
1515
Verify the permissions for your |k8s-op-short|
1616
objects.
1717

18+
:ref:`k8s-signatures`
19+
Verify the signature file before running the MongoDB binary.
20+
1821
:ref:`k8s-gatekeeper`
1922
Control, audit, and debug your deployments by using policies
2023
for the Gatekeeper Open Policy Agent (OPA).

source/verify-signatures.txt

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
.. _k8s-signatures:
2+
3+
=========================
4+
Verify MongoDB Signatures
5+
=========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. facet::
10+
:name: genre
11+
:values: tutorial
12+
13+
.. contents:: On this page
14+
:local:
15+
:backlinks: none
16+
:depth: 1
17+
:class: singlecol
18+
19+
You can require that the {+mdbagent+} verifies the signature file after it
20+
downloads the MongoDB binary by enabling a setting in the :ref:`k8s-om-specification`.
21+
Once you enable signature verification, the {+mdbagent+} requires signature files
22+
for all MongoDB deployments that your |onprem| instance manages.
23+
You can enable signature verification for
24+
:ref:`local or remote deployments <om-local-mode>`.
25+
26+
Prerequisites
27+
-------------
28+
29+
Your |onprem| server must run over |https| so the {+mdbagent+} downloads the
30+
signature files. To learn more, see :ref:`config-https`.
31+
32+
Procedure
33+
---------
34+
35+
.. procedure::
36+
:style: normal
37+
38+
.. step::
39+
40+
In the :ref:`k8s-om-specification`, add
41+
:opsmgrkube:`spec.configuration.mms.featureFlag.automation.verifyDownloads` and set to ``enabled``.
42+
For example:
43+
44+
.. code-block:: yaml
45+
46+
spec:
47+
configuration:
48+
mms.featureFlag.automation.verifyDownloads=enabled
49+
50+
.. note::
51+
52+
Once you enable signature verification, the {+mdbagent+} requires signature
53+
files for all MongoDB binaries that it downloads.
54+
55+
.. step::
56+
57+
Ensure the {+mdbagent+} can locate the MongoDB binary and its signature (.sig)
58+
file from the same directory, the location of which depends on whether your
59+
deployment is :ref:`local or remote <om-local-mode>`.
60+
61+
.. tabs::
62+
63+
.. tab:: Remote
64+
:tabid: remote
65+
66+
If your |onprem| instance can access the Internet or a custom |https|
67+
server and you download the MongoDB binary from the official sources,
68+
the {+mdbagent+} automatically downloads the signature file along with
69+
the MongoDB binary.
70+
71+
If you don't download the MongoDB binary from the official sources,
72+
configure your |https| server to locate the MongoDB binary and its
73+
signature file from the same link.
74+
75+
.. tab:: Local
76+
:tabid: local
77+
78+
If your |onprem| instance can't access the Internet, the MongoDB binary
79+
and its signature file are stored in ``/mongodb-ops-manager/mongodb-releases/``
80+
by default. Ensure the signature file is named the same as the MongoDB
81+
binary and both are in the same directory. For example:
82+
83+
.. code-block:: sh
84+
85+
/mongodb-ops-manager/mongodb-releases/mongodb-linux-x86_64-rhel80-4.2.8.tgz.sig
86+
/mongodb-ops-manager/mongodb-releases/mongodb-linux-x86_64-rhel80-4.2.8.tgz
87+
88+
.. step::
89+
90+
Save and apply the :ref:`k8s-om-specification`.
91+
92+
.. code-block:: sh
93+
94+
kubectl apply -f <my-ops-manager-resource-specification>.yaml
95+
96+
After you've applied the :ref:`k8s-om-specification`, the {+mdbagent+} performs a
97+
:ref:`rolling restart <rolling-restart-faq>` on the cluster nodes, reconciling
98+
the changes.

0 commit comments

Comments
 (0)