Skip to content

Commit ec8693f

Browse files
authored
(DOCSP-53997): Disambiguate coupled vs decoupled architecture for search nodes encryption at rest (#14639)
* disambiguate coupled vs decoupled for search nodes encryption at rest * additional improvements * Copy review feedback
1 parent 7e39be9 commit ec8693f

11 files changed

+70
-20
lines changed
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
By default, MongoDB and :ref:`search processes <about-mongot>` run on the same nodes.
2+
With this architecture, customer-managed encryption applies to your database data,
3+
but it does not apply to search indexes.
4+
5+
When you enable :ref:`dedicated Search Nodes
6+
<what-is-search-node>`, search processes run on separate nodes. This allows
7+
you to enable :ref:`Search Node Data Encryption <enable-search-node-encryption>`,
8+
so you can encrypt both database data and search indexes with the same
9+
customer-managed keys for comprehensive encryption coverage.

content/atlas/source/includes/fts/extracts-fts-search-nodes.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,14 @@ content: |
137137
---
138138
ref: fts-search-nodes-encryption
139139
content: |
140-
You can enable Encryption at Rest with Customer Key Management
141-
for all data on Search Nodes to secure your |search-type| workloads
142-
with customer-managed encryption keys. To learn more, see
140+
141+
.. include:: /includes/fact-search-node-encryption-coverage.rst
142+
143+
To learn more, see
143144
:ref:`enable-search-node-encryption`.
144145
145-
This feature is currently available for Search Nodes on |aws|.
146+
.. note::
147+
148+
.. include:: /includes/fts/facts/fact-search-nodes-kms-availability.rst
146149
147150
...
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
This feature is available across |kms| providers, but the
2+
Search Nodes must be on |aws|.

content/atlas/source/security-aws-kms.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ access to your encryption keys.
4343
You must configure customer key management for the |service| project
4444
before enabling it on {+clusters+} in that project.
4545

46-
.. seealso::
46+
.. seealso::
4747

4848
- :ref:`set-up-unified-aws-access`
4949

@@ -164,16 +164,21 @@ in |service|:
164164

165165
.. include:: /includes/steps-update-aws-kms-region.rst
166166

167-
Next Steps
167+
Next Steps
168168
----------
169169

170170
You can use a customer-managed key (CMK) from your |aws| |kms| over
171171
a public network or over {+aws-pl+}. To learn more, see
172-
the following:
172+
the following:
173173

174174
- :ref:`security-aws-kms-public-network`
175175
- :ref:`security-aws-kms-pvt-endpoint`
176176

177+
Enable Customer-Managed Keys for Search Nodes
178+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
179+
180+
.. include:: /includes/fact-search-node-encryption-coverage.rst
181+
177182
Related Topics
178183
--------------
179184

content/atlas/source/security-azure-kms.txt

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,22 +250,31 @@ Access Policy or |azure| :abbr:`RBAC (Role Based Access Control)`.
250250
]
251251
}
252252

253-
Next Steps
253+
Next Steps
254254
----------
255255

256256
You can use a customer-managed key (CMK) from Azure Key Vault (AKV) over
257257
a public network or over |azure| Private Endpoints. To learn more, see
258-
the following:
258+
the following:
259259

260260
- :ref:`security-azure-kms-pvt-endpoint`
261261
- :ref:`security-azure-kms-public-network`
262262

263263
.. note::
264264

265265
If you've enabled :ref:`security-kms-encryption`, you can
266-
perform encrypt and decrypt operations while at least one node
266+
perform encrypt and decrypt operations while at least one node
267267
is still available during the outage.
268268

269+
Enable Customer-Managed Keys for Search Nodes
270+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
271+
272+
.. include:: /includes/fact-search-node-encryption-coverage.rst
273+
274+
.. note::
275+
276+
.. include:: /includes/fts/facts/fact-search-nodes-kms-availability.rst
277+
269278
.. toctree::
270279
:titlesonly:
271280

content/atlas/source/security-gcp-kms.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,15 @@ Alerts
169169
:alert:`encryption key rotation alert <GCP encryption key elapsed time since last rotation is above (n) days>`
170170
timer at the completion of this procedure.
171171

172+
Enable Customer-Managed Keys for Search Nodes
173+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174+
175+
.. include:: /includes/fact-search-node-encryption-coverage.rst
176+
177+
.. note::
178+
179+
.. include:: /includes/fts/facts/fact-search-nodes-kms-availability.rst
180+
172181
Related Topics
173182
--------------
174183

content/atlas/source/security-kms-encryption.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,14 +119,13 @@ For existing clusters:
119119
Enable Customer Key Management for Search Nodes
120120
-----------------------------------------------
121121

122-
When :ref:`configuring Customer Key Management for your project
123-
<atlas-configure-kms>`, you can also enable encryption with
124-
Customer Key Management for your :ref:`Search Nodes <what-is-search-node>`.
122+
When :ref:`configuring Customer Key Management for your project
123+
<atlas-configure-kms>`, you can also enable encryption with
124+
Customer Key Management for your :ref:`Search Nodes <what-is-search-node>`.
125125
This ensures that your |fts| and {+avs+} workloads, including indexes,
126126
are fully encrypted with your customer-managed keys.
127127

128-
This feature is available across |kms| providers, but the
129-
Search Nodes must be on |aws|.
128+
.. include:: /includes/fts/facts/fact-search-nodes-kms-availability.rst
130129

131130
To enable Search Node Data Encryption with customer-managed keys:
132131

content/atlas/source/security/aws-kms-over-private-endpoint.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ of security by configuring all traffic to your |aws| |kms| to use {+aws-pl+}.
2626
This page describes how to
2727
set up {+aws-pl+} in your |aws| |kms| to ensure that all traffic between
2828
|service| and your |aws| |kms| takes place over |aws|\'s private network
29-
interfaces.
29+
interfaces.
3030

3131
Considerations
3232
--------------
@@ -388,4 +388,7 @@ Related Topics
388388
:manual:`Encryption at Rest </core/security-encryption-at-rest/>` in
389389
the MongoDB server documentation.
390390

391-
- To learn more about Encryption at Rest with {+Cloud-Backup+}s, see :ref:`encrypted-cloud-provider-snapshot`.
391+
- To learn more about Encryption at Rest with {+Cloud-Backup+}s, see :ref:`encrypted-cloud-provider-snapshot`.
392+
393+
- To enable customer key Management for Search Nodes, see :ref:`Enable Search Node Data Encryption
394+
<enable-search-node-encryption>`.

content/atlas/source/security/aws-kms-over-public-network.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ Manage Customer Keys with AWS Over a Public Network
1919
:depth: 2
2020
:class: singlecol
2121

22-
Encrypt your data at rest in |service| with the customer-managed
22+
Encrypt your data at rest in |service| with the customer-managed
2323
keys (CMK) that you create, own, and manage in your |aws| |kms|.
2424

25-
This page describes how to configure customer key management using |aws| |kms|
25+
This page describes how to configure customer key management using |aws| |kms|
2626
on your |service| project and on the {+clusters+} in that project.
2727

2828
.. _aws-ksm-prereqs:
@@ -108,4 +108,9 @@ setting to :guilabel:`Yes` when you create the {+cluster+}.
108108

109109
For existing {+clusters+}:
110110

111-
.. include:: /includes/steps-cluster-customer-key-management.rst
111+
.. include:: /includes/steps-cluster-customer-key-management.rst
112+
113+
Enable Customer Key Management for Search Nodes
114+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115+
116+
.. include:: /includes/fact-search-node-encryption-coverage.rst

content/atlas/source/security/azure-kms-over-private-endpoint.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,3 +426,6 @@ Related Topics
426426
the MongoDB server documentation.
427427

428428
- To learn more about Encryption at Rest with {+Cloud-Backup+}s, see :ref:`encrypted-cloud-provider-snapshot`.
429+
430+
- To enable customer key Management for Search Nodes, see
431+
:ref:`Enable Search Node Data Encryption <enable-search-node-encryption>`.

0 commit comments

Comments
 (0)