Skip to content

Commit 150f01d

Browse files
authored
(DOCSP-46857) Updates more images from design (#108)
* (DOCSP-46857) Updates more images from design * (DOCSP-46857) Updates more diagrams from design and moves the encryption section, updates shared descriptions
1 parent d5db77e commit 150f01d

13 files changed

+84
-238
lines changed

source/data-encryption.txt

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,3 +195,71 @@ Consider the following data classification levels as a starting point:
195195
encryption with customer key management for additional security.
196196

197197
Examples: Revenue information, Payroll, Security Risks
198+
199+
Examples
200+
--------
201+
202+
.. include:: /includes/complete-examples.rst
203+
204+
The following examples configure encryption with customer key management
205+
using |service| :ref:`tools for automation <arch-center-automation>`.
206+
207+
Before you configure encryption with customer key management, you must
208+
create your organizations, projects, and {+clusters+}. To learn more,
209+
see :ref:`arch-center-create-hierarchy-example`.
210+
211+
Configure Encryption with Customer Key Management
212+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213+
214+
.. tabs::
215+
216+
.. tab:: Dev and Test Environments
217+
:tabid: devtest
218+
219+
For your development and testing environments, consider skipping encryption
220+
with customer key management to save costs, unless you're in a highly-regulated industry
221+
or storing sensitive data. To learn more, see :ref:`arch-center-recommendations`.
222+
223+
.. tab:: Staging and Prod Environments
224+
:tabid: stagingprod
225+
226+
For your staging and production environments environments, we
227+
recommend that you enable encryption with customer key management when you provision your {+clusters+}.
228+
To learn more, see :ref:`arch-center-recommendations`.
229+
230+
To enable encryption with customer key management with Terraform,
231+
create the following resources. Change the IDs and names to use your values:
232+
233+
.. tabs::
234+
235+
.. tab:: AWS
236+
:tabid: aws
237+
238+
.. tip::
239+
240+
For a complete configuration example, see
241+
:github:`Atlas Terraform Provider Example <mongodb/terraform-provider-mongodbatlas/blob/master/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster>`.
242+
243+
Alternatively, to simplify the configuration process, you can use the
244+
`encryption at rest Terraform module <https://registry.terraform.io/modules/terraform-mongodbatlas-modules/encryption-at-rest/mongodbatlas/latest>`__.
245+
246+
.. include:: /includes/examples/tf-example-aws-kms.rst
247+
248+
.. tab:: Azure
249+
:tabid: azure
250+
251+
.. tip::
252+
253+
For a complete configuration example, see
254+
:github:`Atlas Terraform Provider Example <mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_encryption_at_rest/azure>`.
255+
256+
.. include:: /includes/examples/tf-example-azure-key-vault.rst
257+
258+
.. tab:: GCP
259+
:tabid: gcp
260+
261+
.. include:: /includes/examples/tf-example-gcp-kms.rst
262+
263+
For more configuration options and info about this example,
264+
see `Terraform documentation
265+
<https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/encryption_at_rest>`__.

source/hierarchy.txt

Lines changed: 7 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -130,11 +130,6 @@ projects and {+clusters+}:
130130
- The back end for your application that is live for your
131131
end users.
132132

133-
Encryption with Customer Key Management
134-
```````````````````````````````````````
135-
136-
.. include:: /includes/encryption-with-cmk-recommendations.rst
137-
138133
Local {+service+} Deployments
139134
`````````````````````````````
140135

@@ -143,7 +138,7 @@ For your dev and test environments, you can also develop {+service+}
143138
to work locally from their machine and cut down on costs for
144139
development and test environments. To learn more, see
145140
:atlascli:`Create a Local {+service+} Deployment
146-
<atlas-cli-deploy-local>`.
141+
</atlas-cli-deploy-local>`.
147142

148143
Org and Project Hierarchies
149144
````````````````````````````
@@ -159,7 +154,8 @@ If you will easily hit the 250 project limit per organization, we
159154
recommend creating one organization per environment, such as one each
160155
for lower and upper environments, or one each for dev, test, staging,
161156
and production. This setup has the benefit of additional isolation. You can also
162-
increase the limits. To learn more, see :atlas:`<atlas-limits>`.
157+
increase the limits. To learn more, see
158+
:atlas:`{+service+} Service Limits </reference/atlas-limits>`.
163159

164160
.. _project-hierarchy-1:
165161

@@ -169,7 +165,7 @@ Recommended Hierarchy
169165
Consider the following hierarchy, which creates fewer |service| organizations, if you have common teams and permissions across the
170166
{+BU+} and less than the raiseable limit of 250 projects per organization.
171167

172-
.. figure:: /includes/images/paying-org-hierarchy.png
168+
.. figure:: /includes/images/paying-org-hierarchy.svg
173169
:alt: An image showing a paying organization with other organizations nested beneath it.
174170
:align: center
175171
:lightbox:
@@ -189,7 +185,7 @@ buy credits themselves through the cloud provider marketplace or
189185
directly with their own contract. There is no paying organization in
190186
this hierarchy.
191187

192-
.. figure:: /includes/images/no-paying-org-hierarchy.png
188+
.. figure:: /includes/images/no-paying-org-hierarchy.svg
193189
:alt: An image showing multiple organizations without a paying organization above them.
194190
:align: center
195191
:lightbox:
@@ -203,7 +199,7 @@ To maintain isolation between environments, we recommend that you deploy
203199
{+cluster+}s that belong to the same application and are administered
204200
by the same team in the same project, as shown in the following diagram:
205201

206-
.. figure:: /includes/images/deployment-hierarchy.png
202+
.. figure:: /includes/images/deployment-hierarchy.svg
207203
:alt: An image showing one deployment per project in each organization.
208204
:align: center
209205
:lightbox:
@@ -224,7 +220,7 @@ You should use this hierarchy only if both of the following are true:
224220
{+clusters+} should belong to the same application and be administered
225221
by the same team in the same project.
226222

227-
.. figure:: /includes/images/alt-deployment-by-environment.png
223+
.. figure:: /includes/images/alt-deployment-by-environment.svg
228224
:alt: An image showing deployments grouped by environment.
229225
:align: center
230226
:lightbox:
@@ -545,65 +541,6 @@ These examples also apply other recommended configurations, including:
545541
see |service-terraform| and the `MongoDB Terraform Blog Post
546542
<https://www.mongodb.com/developer/products/atlas/deploy-mongodb-atlas-terraform-aws/>`__.
547543

548-
Configure Encryption with Customer Key Management
549-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
550-
551-
.. tabs::
552-
553-
.. tab:: Dev and Test Environments
554-
:tabid: devtest
555-
556-
For your development and testing environments, consider skipping encryption
557-
with customer key management to save costs, unless you're in a highly-regulated industry
558-
or storing sensitive data. To learn more, see :ref:`arch-center-recommendations`.
559-
560-
.. tab:: Staging and Prod Environments
561-
:tabid: stagingprod
562-
563-
For your staging and production environments environments, we
564-
recommend that you enable encryption with customer key management when you provision your {+clusters+}.
565-
To learn more, see :ref:`arch-center-recommendations`.
566-
567-
To enable encryption with customer key management with Terraform,
568-
create the following resources. Change the IDs and names to use your values:
569-
570-
.. tabs::
571-
572-
.. tab:: AWS
573-
:tabid: aws
574-
575-
.. tip::
576-
577-
For a complete configuration example, see
578-
:github:`Atlas Terraform Provider Example <mongodb/terraform-provider-mongodbatlas/blob/master/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster>`.
579-
580-
Alternatively, to simplify the configuration process, you can use the
581-
`encryption at rest Terraform module <https://registry.terraform.io/modules/terraform-mongodbatlas-modules/encryption-at-rest/mongodbatlas/latest>`__.
582-
583-
.. include:: /includes/examples/tf-example-aws-kms.rst
584-
585-
.. tab:: Azure
586-
:tabid: azure
587-
588-
.. tip::
589-
590-
For a complete configuration example, see
591-
:github:`Atlas Terraform Provider Example <mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_encryption_at_rest/azure>`.
592-
593-
.. include:: /includes/examples/tf-example-azure-key-vault.rst
594-
595-
.. tab:: GCP
596-
:tabid: gcp
597-
598-
.. include:: /includes/examples/tf-example-gcp-kms.rst
599-
600-
For more configuration options and info about this example,
601-
see `Terraform documentation
602-
<https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/encryption_at_rest>`__.
603-
604-
Create the Projects and Deployments
605-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
606-
607544
After you create the files, navigate to each application and environment pair's directory and run the following
608545
command to initialize Terraform:
609546

Binary file not shown.
-18.3 KB
Binary file not shown.

source/includes/images/deployment-hierarchy.svg

Lines changed: 1 addition & 63 deletions
Loading
Binary file not shown.

0 commit comments

Comments
 (0)