Skip to content

Commit 9426f0e

Browse files
authored
Adds small edits across pages (#120)
1 parent ec1b913 commit 9426f0e

File tree

7 files changed

+51
-49
lines changed

7 files changed

+51
-49
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ play-store = "https://play.google.com/store/apps/"
170170
vault = "`HashiCorp Vault <https://www.vaultproject.io/>`__"
171171
vpc = ":abbr:`VPC (Virtual Private Cloud)`"
172172
vnet = "VNet"
173-
waf = "`Atlas Well-Architected Framework <https://www.mongodb.com/>`__"
173+
waf = "Atlas Well-Architected Framework"
174174
wif = "Workforce Identity Federation"
175175
workload = "Workload Identity Federation"
176176

source/auth.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ minimize the risk of unauthorized access:
258258

259259
- Follow best practices for
260260
rotating |api| keys regularly. To learn how to rotate these keys with
261-
{+vault+}, see `the Hashicorp documentation <https://developer.hashicorp.com/vault/docs/secrets/mongodbatlas>`__.
261+
{+vault+}, for example, see `the Hashicorp documentation <https://developer.hashicorp.com/vault/docs/secrets/mongodbatlas>`__.
262262

263263
- Use the IP access list for your API keys. To learn more, see
264264
:atlas:`Require an IP Access List for the {+atlas-admin-api+} </configure-api-access/#optional--require-an-ip-access-list-for-the-atlas-administration-api>`.

source/automation.txt

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _arch-center-automation:
22

3-
==========
4-
Automation
5-
==========
3+
=====================================
4+
Automated Infrastructure Provisioning
5+
=====================================
66

77
.. default-domain:: mongodb
88

@@ -62,17 +62,6 @@ programming language or bash script.
6262

6363
To learn more, see :ref:`atlas-admin-api-access`.
6464

65-
GoSDK Client
66-
````````````
67-
68-
The {+service+} Go SDK client simplifies interaction with the
69-
{+atlas-admin-api+} by providing pre-built functions and full |api|
70-
endpoint coverage. The SDK provides platform-specific and GoLang
71-
language-specific tools, libraries, and documentation to help build
72-
applications quickly and easily.
73-
74-
To learn more, see :ref:`Atlas Go SDK <atlas-admin-sdk>`.
75-
7665
.. _arch-center-iac:
7766

7867
HashiCorp Terraform MongoDB Atlas Provider
@@ -94,6 +83,17 @@ Cluster<arch-center-hierarchy>` examples to get started.
9483

9584
.. include:: /includes/complete-examples.rst
9685

86+
GoSDK Client
87+
````````````
88+
89+
The {+service+} Go SDK client simplifies interaction with the
90+
{+atlas-admin-api+} by providing pre-built functions and full |api|
91+
endpoint coverage. The SDK provides platform-specific and GoLang
92+
language-specific tools, libraries, and documentation to help build
93+
applications quickly and easily.
94+
95+
To learn more, see :ref:`Atlas Go SDK <atlas-admin-sdk>`.
96+
9797
CloudFormation Resources
9898
````````````````````````
9999

@@ -148,10 +148,7 @@ the same tooling and pipelines and use the |ak8so| to automate updating
148148
If you don't already have an existing tool integrated into your
149149
development workflow, we recommend an :ref:`IaC tool <arch-center-iac>`
150150
because they provide more robust options for infrastructure provisioning
151-
and state management. If you instead call the {+atlas-admin-api+}
152-
directly or use the GoSDK, which wraps the {+atlas-admin-api+}, you
153-
might need to recreate your infrastructure provisioning each time to
154-
match your needs across environments.
151+
and state management.
155152

156153
You can also use a combination of multiple tools. For example, use IaC
157154
tool for provisioning and state management, and leverage the

source/hierarchy.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,8 @@ To learn more about parsing billing data using tags, see
250250

251251
In a dedicated deployment ({+cluster+} size ``M10``\+), {+service+}
252252
allocates resources exclusively. We recommend dedicated deployments
253-
because they provide high security and performance.
253+
because they provide higher security and performance than shared
254+
clusters.
254255

255256
Use the following {+cluster+} size guide to select a {+cluster+} tier that ensures performance without over-provisioning. The {+cluster+} size guide also provides recommendations on which {+cluster+} tiers
256257
are suitable for development and testing environments, and which are
@@ -292,7 +293,7 @@ the {+cluster+} resources required by using your organization's approximate data
292293
- Storage Range: Azure
293294
- CPUs (#)
294295
- Default RAM
295-
- IOPS
296+
- Default IOPS
296297
- Recommended For
297298

298299
* - Small

source/landing-zone.txt

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,11 @@ pre-configured cloud environment for {+service+} that conforms to your organizat
4848
move workloads to the cloud, and it is often provisioned
4949
programmatically using an API or tools like Terraform.
5050

51-
An {+service+} landing zone defines the default and minimum settings
52-
that teams use to deploy workloads in {+service+}. A landing zone also
53-
defines the tools and settings that teams should leverage in order to
54-
integrate systems with {+service+} and their applications connecting to {+service+}.
51+
An {+service+} landing zone defines the default, minimum, and maximum
52+
settings that teams use to deploy workloads in {+service+}. A landing
53+
zone also defines the tools and settings that teams should leverage in
54+
order to integrate systems with {+service+} and their applications
55+
connecting to {+service+}.
5556

5657
Why Do You Need a Landing Zone?
5758
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -82,13 +83,16 @@ requirements when you create a landing zone:
8283
* - System Hierarchy Requirements
8384
- Identify how you will group database {+clusters+} for management
8485
and isolation. For example, clarify how your team should arrange
85-
{+service+} projects or {+service+} organizations.
86+
{+service+} organizations, projects, and {+clusters+}.
8687

8788
To get recommendations and learn more about this topic, see
8889
:ref:`arch-center-hierarchy`.
8990
* - Access Controls
9091
- Identify MongoDB {+service+} Control Plane access controls, and
91-
database access controls for both workload and workforce principals. Create a comprehensive list of principals and mechanisms for how you will authenticate and authorize. Define {+service+} API key access controls, including authorizations and expiration rules.
92+
database access controls for both workload and workforce principals. Create a comprehensive list of principals and mechanisms for how you will authenticate and authorize. Define {+service+} API key policies, including authorizations and internal policies for key rotation.
93+
94+
To get recommendations and learn more about this topic, see
95+
:ref:`arch-center-auth`.
9296
* - Change Control and Auditability Requirements
9397
- Clarify any change control or audit controls requirements. This
9498
can include change approval processes and tools, along with

source/network-security.txt

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,26 @@ you must update your connection string to reflect your new cluster topology.
114114
In the case of adding new shards, the failure to reconnect the application
115115
clients may cause your application to suffer from a data outage.
116116

117+
Private Endpoints
118+
`````````````````
119+
120+
A private endpoint facilitates a one-way connection from your own |vpc|
121+
to your {+service+} |vpc|, without permitting {+service+} to initiate a
122+
reciprocal connection. This allows you to make use of secure connections
123+
to {+service+} without extending your network trust boundary. The following
124+
private endpoints are available:
125+
126+
- {+aws+} :aws:`PrivateLink </vpc/latest/userguide/endpoint-services-overview.html>`,
127+
for connections from {+aws+} |vpc|\s
128+
- {+azure+} :azure:`Private Link </private-link/private-link-overview>`,
129+
for connections from {+azure+} {+vnet+}s
130+
- :gcp:`Private Service Connect </vpc/docs/private-service-connect>`,
131+
for connections from {+gcp+} |vpc|\s
132+
133+
.. figure:: /includes/images/private-link.svg
134+
:alt: "An image representing how MongoDB Atlas private endpoints work."
135+
:figwidth: 750px
136+
117137
VPC/{+vnet+} Peering
118138
`````````````````````````````
119139

@@ -140,26 +160,6 @@ based on the |cidr| block. For example, a project with a |cidr| block of
140160
:alt: "An image representing how MongoDB Atlas VPC/VNet peering works."
141161
:figwidth: 750px
142162

143-
Private Endpoints
144-
`````````````````
145-
146-
A private endpoint facilitates a one-way connection from your own |vpc|
147-
to your {+service+} |vpc|, without permitting {+service+} to initiate a
148-
reciprocal connection. This allows you to make use of secure connections
149-
to {+service+} without extending your network trust boundary. The following
150-
private endpoints are available:
151-
152-
- {+aws+} :aws:`PrivateLink </vpc/latest/userguide/endpoint-services-overview.html>`,
153-
for connections from {+aws+} |vpc|\s
154-
- {+azure+} :azure:`Private Link </private-link/private-link-overview>`,
155-
for connections from {+azure+} {+vnet+}s
156-
- :gcp:`Private Service Connect </vpc/docs/private-service-connect>`,
157-
for connections from {+gcp+} |vpc|\s
158-
159-
.. figure:: /includes/images/private-link.svg
160-
:alt: "An image representing how MongoDB Atlas private endpoints work."
161-
:figwidth: 750px
162-
163163
Recommendations for Private Endpoints
164164
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
165165

source/scalability.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Upgrading an {+service+} {+cluster+} to the next available {+service+} tier is a
4444
{+service+} control plane GUI, the
4545
`Atlas Administration API <https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster>`__,
4646
or through IaC tools, such as the |ak8so|, the |service-terraform|, or the {+atlas-cli+}. See
47-
:ref:`Automation <arch-center-automation>` to learn more. Changing an {+service+} tier, either upscaling or
47+
:ref:`arch-center-automation` to learn more. Changing an {+service+} tier, either upscaling or
4848
downscaling, allows zero downtime. The tier changes in a rolling fashion, which involves electing a secondary
4949
member as a replacement, promoting this secondary member to become the new primary, then restoring or replacing
5050
the failing member to ensure that the cluster is returned to its target configuration as soon as possible.

0 commit comments

Comments
 (0)