Skip to content

Commit f7b62b0

Browse files
committed
(DOCSP-39678): Adds includes for nav to top-level Atlas pages.
1 parent 61b0ce7 commit f7b62b0

9 files changed

+320
-377
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. step:: Go to the :guilabel:`Network Access` page for your project.
2+
3+
a. If it's not already displayed, select the
4+
organization that contains your project from the
5+
|ui-org-menu| in the navigation bar.
6+
7+
#. If it's not already displayed, select your project
8+
from the :guilabel:`Projects` menu in the navigation bar.
9+
10+
#. In the sidebar, click :guilabel:`Network Access` under
11+
the :guilabel:`Security` heading.
Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
.. procedure::
2+
:style: normal
3+
4+
5+
.. include:: /includes/atlas-nav/steps-network-access.rst
6+
7+
.. step:: Create a private endpoint.
8+
9+
a. Click the :guilabel:`Private Endpoint` tab.
10+
11+
#. Click :guilabel:`Add Private Endpoint`.
12+
13+
.. step:: Choose a cloud provider.
14+
15+
Click the |aws| logo, then click :guilabel:`Next`.
16+
17+
.. step:: Choose a region.
18+
19+
a. From the :guilabel:`Atlas Region` list, select the region
20+
in which you want to create the private endpoint.
21+
22+
#. Click :guilabel:`Next`.
23+
24+
|cloudgov-short| creates |vpc| resources in the region
25+
you selected. This might take several minutes to complete.
26+
27+
.. step:: Configure your private endpoint.
28+
29+
a. Enter the following details about your |aws| |vpc|:
30+
31+
.. list-table::
32+
:widths: 20 80
33+
34+
* - :guilabel:`Your VPC ID`
35+
- Unique identifier of the peer |aws| |vpc|. Find this
36+
value on the |vpc| dashboard in your |aws| account.
37+
38+
* - :guilabel:`Your Subnet IDs`
39+
- Unique identifiers of the subnets your |aws| |vpc| uses.
40+
Find these values on the :guilabel:`Subnet` dashboard in
41+
your |aws| account.
42+
43+
.. important::
44+
45+
You must specify at least one subnet. If you don't,
46+
|aws| won't provision an interface endpoint in
47+
your |vpc|. An is required for
48+
clients in your |vpc| to send traffic to the private endpoint.
49+
50+
#. Copy the command the dialog displays and run it using the |aws|
51+
CLI.
52+
53+
.. note::
54+
55+
You can't copy the command until |cloudgov-short| finishes
56+
creating |vpc| resources in the background.
57+
58+
See :aws:`Creating an Interface Endpoint </vpc/latest/userguide/vpce-interface.html#create-interface-endpoint>` to perform this task using the |aws| CLI.
59+
60+
#. You might receive an error like the following when you create
61+
the private endpoint:
62+
63+
.. code-block:: sh
64+
:copyable: false
65+
66+
An error occurred (InvalidParameter) when calling the CreateVpcEndpoint
67+
operation: The VPC endpoint service com.amazonaws.vpce.us-east-1.vpce-svc-<...>
68+
does not support the availability zone of the subnet: subnet-<...>.
69+
70+
If you receive this error, |cloudgov-short| has deployed |vpc|
71+
resources into different availability zones than the ones to
72+
which you deployed your |vpc| subnets.
73+
Please contact MongoDB Support for assistance resolving this
74+
error. To contact support, click :guilabel:`Support` from the
75+
left-hand navigation bar of the |cloudgov-short| UI.
76+
77+
#. Click :guilabel:`Next`.
78+
79+
.. step:: Finalize your private endpoint connection.
80+
81+
a. Enter your :guilabel:`VPC Endpoint ID`. This is a
82+
22-character alphanumeric string that identifies your private
83+
endpoint. Find this value on the |aws| VPC Dashboard under
84+
:guilabel:`Endpoints` > :guilabel:`VPC ID`.
85+
86+
#. Click :guilabel:`Create`.
87+
88+
.. step:: Configure your resources' security groups to send traffic to and receive traffic from the interface endpoint.
89+
90+
For each resource that needs to connect to your |cloudgov-short|
91+
clusters using {+aws-pl+}, the resource's security group must allow
92+
outbound traffic to the interface endpoint's private IP(s) on all
93+
ports.
94+
95+
See :aws:`Adding Rules to a Security Group </AWSEC2/latest/UserGuide/ec2-security-groups.html#adding-security-group-rule>` in the |aws|
96+
documentation for more information.
97+
98+
.. step:: Create a security group for your interface endpoint to allow resources to access it.
99+
100+
This security group must allow inbound traffic on all ports from each
101+
resource that needs to connect to your |cloudgov-short| clusters
102+
using {+aws-pl+}:
103+
104+
a. In the |aws| console, navigate to the :guilabel:`VPC Dashboard`.
105+
106+
#. Click :guilabel:`Security Groups`, then click
107+
:guilabel:`Create security group`.
108+
109+
#. Use the wizard to create a security group. Make sure you select
110+
your VPC from the :guilabel:`VPC` list.
111+
112+
#. Select the security group you just created, then click the
113+
:guilabel:`Inbound Rules` tab.
114+
115+
#. Click :guilabel:`Edit Rules`.
116+
117+
#. Add rules to allow all inbound traffic from each resource in your
118+
VPC that you want to connect to your |cloudgov-short| cluster.
119+
120+
#. Click :guilabel:`Save Rules`.
121+
122+
#. Click :guilabel:`Endpoints`, then click the endpoint for your
123+
VPC.
124+
125+
#. Click the :guilabel:`Security Groups` tab, then click
126+
:guilabel:`Edit Security Groups`.
127+
128+
#. Add the security group you just created, then click
129+
:guilabel:`Save`.
130+
131+
See :aws:`VPC security groups
132+
</vpc/latest/userguide/VPC_SecurityGroups.html>` in the |aws|
133+
documentation for more information.
134+
135+
.. include:: /includes/atlas-nav/steps-network-access.rst
136+
137+
.. step:: Verify that the private endpoint is available.
138+
139+
You can connect to an |cloudgov-short| cluster using the {+aws-pl+}
140+
private endpoint when all of the resources are configured and the
141+
private endpoint becomes available.
142+
143+
To verify that the {+aws-pl+} private endpoint is available:
144+
145+
a. On the :guilabel:`Private Endpoint` tab, verify the following
146+
statuses for the region that contains the cluster
147+
you want to connect to using {+aws-pl+}:
148+
149+
.. list-table::
150+
:widths: 20 80
151+
152+
* - :guilabel:`Atlas Endpoint Service Status`
153+
- Ready for connection requests
154+
155+
* - :guilabel:`Endpoint Status`
156+
- Available
157+
158+
If you do not see these statuses, see
159+
:ref:`privatelink-troubleshooting` for additional information.
160+

source/includes/privatelink/steps-configure-privatelink-aws.yaml

Lines changed: 0 additions & 211 deletions
This file was deleted.

0 commit comments

Comments
 (0)