Skip to content

Commit 56ad454

Browse files
authored
DOCSP-7525 clarify how to specify multiple KMIP hosts (#2792)
* DOCSP-7525 clarify how to specify multiple KMIP hosts * Revert "DOCSP-7525 clarify how to specify multiple KMIP hosts" This reverts commit d30444820aa98d882e347694aa2ad6c41f0623c0. * internal review -- seealso * external review feedback * fix up merge conflicts
1 parent 9ffbf66 commit 56ad454

File tree

4 files changed

+36
-20
lines changed

4 files changed

+36
-20
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Starting in MongoDB 4.2.1 (and 4.0.14), you can specify multiple KMIP
2+
servers as a comma-separated list.
3+
4+
.. example::
5+
6+
To specify both ``server1.example.com`` and ``server2.example.com``
7+
as KMIP servers, set |kmipServerName| to ``"server1.example.com,server2.example.com"``.
8+
9+
You cannot specify the port number in |kmipServerName|. Instead,
10+
specify the port with |kmipPort|. You may only specify one port and
11+
each host must use that port.
12+
13+
On startup, :binary:`~bin.mongod` attempts to establish a connection to
14+
each server in the order listed and selects the first server it can
15+
connect to. KMIP server selection only occurs at startup.

source/reference/configuration-options.txt

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2858,16 +2858,12 @@ Key Management Configuration Options
28582858
*Type*: string
28592859

28602860

2861-
Hostname or IP address of the KMIP server to connect to. Requires
2862-
:setting:`security.enableEncryption` to be true.
2861+
Hostname or IP address of the KMIP server to connect to.
2862+
:setting:`security.enableEncryption` must be set to ``true``.
28632863

2864-
Starting in MongoDB 4.2.1 (and 4.0.14), you can specify multiple KMIP
2865-
servers as a comma-separated list, e.g.
2866-
``server1.example.com,server2.example.com``. On startup, the
2867-
:binary:`~bin.mongod` will attempt to establish a connection to each
2868-
server in the order listed, and will select the first server to
2869-
which it can successfully establish a connection. KMIP server
2870-
selection occurs only at startup.
2864+
.. |kmipServerName| replace:: ``security.kmip.serverName``
2865+
.. |kmipPort| replace:: ``security.kmip.port``
2866+
.. include:: /includes/fact-specify-kmip-serverName.rst
28712867

28722868
.. include:: /includes/reference/fact-connection-check.rst
28732869

source/reference/program/mongod.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3129,17 +3129,15 @@ Encryption Key Management Options
31293129

31303130

31313131
.. option:: --kmipServerName <string>
3132-
3132+
3133+
.. _specify-mulitple-kmip-servers:
3134+
31333135
Hostname or IP address of the KMIP server to connect to. Requires
31343136
:option:`--enableEncryption`.
31353137

3136-
Starting in MongoDB 4.2.1, you can specify multiple KMIP
3137-
servers as a comma-separated list, e.g.
3138-
``server1.example.com,server2.example.com``. On startup, the
3139-
:binary:`~bin.mongod` will attempt to establish a connection to each
3140-
server in the order listed, and will select the first server to
3141-
which it can successfully establish a connection. KMIP server
3142-
selection occurs only at startup.
3138+
.. |kmipServerName| replace:: ``security.kmip.serverName``
3139+
.. |kmipPort| replace:: ``security.kmip.port``
3140+
.. include:: /includes/fact-specify-kmip-serverName.rst
31433141

31443142
.. _KMIP-subject-alternative-name-CN:
31453143

source/tutorial/configure-encryption.txt

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,10 @@ generates for each database.
105105
--kmipServerCAFile ca.pem \
106106
--kmipClientCertificateFile client.pem
107107

108+
The {+dek-long+} is unique for each server process. That is, if there
109+
are three replica set members, each replica set member has a unique
110+
{+dek-long+}.
111+
108112
.. include:: /includes/reference/fact-connection-check.rst
109113

110114
To verify that the key creation and usage was successful, check the log
@@ -117,7 +121,8 @@ file. If successful, the process will log the following messages:
117121

118122
.. seealso::
119123

120-
:ref:`encryption-key-management-options`
124+
- :ref:`encryption-key-management-options`
125+
- :ref:`Specify Multiple KMIP Servers <specify-mulitple-kmip-servers>`
121126

122127
.. _encrypt-with-existing-key:
123128

@@ -152,7 +157,8 @@ manages. To use an existing key, use these options when you start
152157

153158
.. seealso::
154159

155-
:ref:`encryption-key-management-options`
160+
- :ref:`encryption-key-management-options`
161+
- :ref:`Specify Multiple KMIP Servers <specify-mulitple-kmip-servers>`
156162

157163
.. _encrypt-local-key-mgmt:
158164

@@ -208,7 +214,8 @@ accessible by the owner of the :binary:`~bin.mongod` process.
208214

209215
.. seealso::
210216

211-
:ref:`encryption-key-management-options`
217+
- :ref:`encryption-key-management-options`
218+
- :ref:`Specify Multiple KMIP Servers <specify-mulitple-kmip-servers>`
212219

213220
.. _encrypt-existing-data:
214221

0 commit comments

Comments
 (0)