Skip to content

Commit 10083e9

Browse files
authored
(DOCSP-45897) Revises per explicit edits from v1 review. (#52)
* (DOCSP-45897) Revises per explicit edits from v1 review. * Revises per copy review.
1 parent 5cecde3 commit 10083e9

File tree

1 file changed

+45
-33
lines changed

1 file changed

+45
-33
lines changed

source/network-security.txt

Lines changed: 45 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,17 @@ configuration of your {+clusters+}.
4040
{+service+} enforces |tls-ssl| encryption for all connections to your
4141
databases.
4242

43-
All {+service+} projects with one or more M10+ dedicated {+clusters+} receive
43+
We recommend using M10+ dedicated {+clusters+} because all {+service+} projects with one or more M10+ dedicated {+clusters+} receive
4444
their own dedicated |vpc| on {+aws+} or {+gcp+} (or {+vnet+} if you use |azure|).
4545
{+service+} deploys all dedicated clusters inside this |vpc| or {+vnet+}.
4646

47-
By default, this |vpc| or {+vnet+} allows no inbound access to {+service+}.
48-
You must explicitly enable access by one of the following methods:
47+
By default, all access to your {+clusters+} is blocked. You must explicitly allow
48+
an inbound connection by one of the following methods:
4949

50-
- Add public IP addresses to your {+ip-access-list+}
51-
- Use |vpc| / {+vnet+} peering to add private IP addresses
52-
- Add private endpoints
50+
- Add public IP addresses to your {+ip-access-list+}.
51+
- Use |vpc| / {+vnet+} peering to add private IP addresses.
52+
- Add private endpoints, which {+service+} adds automatically to your {+ip-access-list+}.
53+
No other access is automatically added.
5354

5455
You can also use multiple methods together for added security.
5556

@@ -61,7 +62,8 @@ Features
6162

6263
{+service+} enforces mandatory |tls| encryption of connections to your
6364
databases. |tls| 1.2 is the default protocol; you can select |tls| 1.1
64-
or |tls| 1.0 if necessary. To learn more, see the
65+
or |tls| 1.0 if necessary, but we do not recommend protocols lower than
66+
the default. To learn more, see the
6567
:guilabel:`Set Minimum TLS Protocol Version` section of
6668
:ref:`Configure Additional Settings
6769
<create-cluster-additional-settings>`.
@@ -88,10 +90,10 @@ You can create one access list per project.
8890
Firewall Configuration
8991
``````````````````````
9092

91-
If you use a firewall that blocks outbound network connections, you
92-
must also configure your firewall to allow your applications to make
93-
outbound connections to TCP traffic on {+service+} hosts. This grants
94-
your applications access to your {+clusters+}.
93+
When connecting from your client application servers to {+service+} and passing
94+
through a firewall that blocks outbound network connections, you must also configure
95+
your firewall to allow your applications to make outbound connections to TCP traffic
96+
on {+service+} hosts. This grants your applications access to your {+clusters+}.
9597

9698
{+service+} {+cluster+} public IPs remain the same in the majority of
9799
cases of {+cluster+} changes such as :ref:`vertical scaling
@@ -108,13 +110,13 @@ VPC/{+vnet+} Peering
108110

109111
Network peering allows you to connect your own |vpc|\s with |a-service|
110112
|vpc| to route traffic privately and isolate your data flow from the
111-
public Internet.
113+
public Internet. {+service+} maps |vpc|\s one-to-one to {+service+} projects.
112114

113115
Most operations performed over a |vpc| connection originate from your
114116
application environment, minimizing the need for {+service+} to make
115-
outbound access requests to peer |vpc|\s. However, if you configure a
116-
peer |vpc| to use |ldap| authentication, you must enable {+service+} to
117-
connect to the authentication endpoint of your peer |vpc| over the |ldap|
117+
outbound access requests to peer |vpc|\s. However, if you configure {+service+}
118+
to use |ldap| authentication, you must enable {+service+} to
119+
connect outbound to the authentication endpoint of your peer |vpc| over the |ldap|
118120
protocol.
119121

120122
You can choose your {+service+} |cidr| block with the |vpc| peering wizard
@@ -140,16 +142,41 @@ private endpoints are available:
140142
- :gcp:`Private Service Connect </vpc/docs/private-service-connect>`, for
141143
connections from {+gcp+}
142144

145+
Recommendations for Private Endpoints
146+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
147+
148+
We recommend that you set up private endpoints for all new staging and production projects to limit the extension of your network trust
149+
boundary.
150+
151+
In general, we recommend using private endpoints for every {+service+} project
152+
because it provides the most granular security and eases the administrative burden
153+
that can come from managing {+ip-access-list+}\s and large blocks of IP addresses
154+
as your cloud network scales. There is a cost associated with each endpoint, so you
155+
might consider not requiring private endpoints in lower environments but you should
156+
leverage them in higher environments to limit the extension of your network trust
157+
boundary.
158+
159+
To learn more about private endpoints
160+
in {+service+}, including limitations and considerations, see :atlas:`Learn About Private Endpoints in {+service+} </security-private-endpoint/>`. To learn how to set up private
161+
endpoints for your {+clusters+}, see
162+
:atlas:`Set Up a Private Endpoint for a Dedicated Cluster </security-cluster-private-endpoint/>`.
163+
143164
Recommendations for IP Access Lists
144165
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145166

146-
We recommend that you configure an {+ip-access-list+} for your API keys
147-
to allow access only from trusted IP addresses.
167+
We recommend that you configure an {+ip-access-list+} for your API keys and programmatic
168+
access to allow access only from trusted IP addresses such as your CI/CD pipeline
169+
or orchestration system. These {+ip-access-list+}\s are set on the {+service+}
170+
control plane upon provisioning a service account and are separate from {+ip-access-list+}\s
171+
which can be set on the {+service+} project data plane for connections to the {+clusters+}.
148172

149173
When you configure your {+ip-access-list+}, we recommend that you:
150174

151175
- Use temporary access list entries in situations where team members
152-
require access to your environment from temporary work locations.
176+
require access to your environment from temporary work locations or during
177+
break-glass scenarios where production access to humans is required to resolve
178+
a production-down scenario. We recommend that you build an automation script to
179+
quickly add temporary access to prepare for these incidents.
153180
- Define {+ip-access-list+} entries covering the smallest network segments
154181
possible. To do this, favor individual IP addresses where possible,
155182
and avoid large |cidr| blocks.
@@ -169,21 +196,6 @@ If you configure |vpc| or {+vnet+} peering, we recommend that you:
169196
intransitive, allowing you to only expose those components of your
170197
application that need access to {+service+}.
171198

172-
Recommendations for Private Endpoints
173-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174-
175-
We recommend that you set up private endpoints for all new staging and production projects to limit the extension of your network trust
176-
boundary.
177-
178-
When you configure your private endpoints, we recommend that you don't
179-
share private endpoints across multiple projects to ensure isolation
180-
of configuration settings.
181-
182-
To learn more about private endpoints
183-
in {+service+}, including limitations and considerations, see :atlas:`Learn About Private Endpoints in {+service+} </security-private-endpoint/>`. To learn how to set up private
184-
endpoints for your {+clusters+}, see
185-
:atlas:`Set Up a Private Endpoint for a Dedicated Cluster </security-cluster-private-endpoint/>`.
186-
187199
Examples
188200
--------
189201

0 commit comments

Comments
 (0)