Skip to content

Commit aedb452

Browse files
kanchana-mongodbkanchana-mongodb
authored
DOCSP-18114 doc for ADL private link (#207)
* DOCSP-18114 doc for ADL private link * DOCSP-18114 updates for review feedback * DOCSP-18114 new file for configuring connection type * DOCSP-18114 added note for 0.0.0.0 IP address * DOCSP-18114 updates for review feedback
1 parent d113f45 commit aedb452

21 files changed

+744
-99
lines changed

‎snooty.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title = "MongoDB Atlas Data Lake"
33

44
intersphinx = ["https://docs.mongodb.com/manual/objects.inv","https://docs.atlas.mongodb.com/objects.inv","https://docs.mongodb.com/database-tools/objects.inv","https://docs.mongodb.com/mongodb-shell/objects.inv"]
55

6-
toc_landing_pages = ["/config/config-data-lake", "/tutorial/getting-started", "/admin/query-with-sql", "/query/query-data-lake", "/tutorial/connect", "/supported-unsupported/mql-support"]
6+
toc_landing_pages = ["/config/config-data-lake", "/tutorial/getting-started", "/admin/query-with-sql", "/query/query-data-lake", "/tutorial/connect", "/supported-unsupported/mql-support", "/tutorial/configure-connection"]
77

88
[constants]
99
adl = "Atlas Data Lake"
@@ -114,6 +114,7 @@ tls-ssl = ":abbr:`TLS (Transport Layer Security)` :abbr:`SSL (Secure Sockets Lay
114114
tls = ":abbr:`TLS (Transport Layer Security)`"
115115
totp = ":abbr:`TOTP (Time-based One-time Password Algorithm)`"
116116
udp = ":abbr:`UDP (User Datagram Protocol)`"
117+
ui-org-menu = ":icon-mms:`office` :guilabel:`Organizations` menu"
117118
upn = ":abbr:`UPN (User Principal Name)`"
118119
uri = ":abbr:`URI (Uniform Resource Identifier)`"
119120
url = ":abbr:`URL (Uniform Resource Locator)`"

‎source/admin/delete-private-endpoint.txt

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _delete-private-endpoint:
2+
3+
===============================================
4+
Delete a Private Endpoint for a {+dl+}
5+
===============================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can delete a private endpoint for your {+dl+}s from the
16+
|service| User Interface and |api|.
17+
18+
Delete Private Endpoint Through the User Interface
19+
--------------------------------------------------
20+
21+
To delete a private endpoint from the |service| UI:
22+
23+
.. include:: /includes/steps/delete-privatelink.rst
24+
25+
Delete a Private Endpoint Through Through the API
26+
-------------------------------------------------
27+
28+
To delete a private endpoint through the |api|, send a ``DELETE``
29+
request to the :ref:`privateNetworkSettings/endpointIds
30+
<adl-api>` endpoint with the ID of the private endpoint to
31+
delete. To learn more about the |api| syntax and options, see
32+
:ref:`api-pvt-link-delete-one`.

‎source/admin/edit-private-endpoint.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. _edit-private-endpoint:
2+
3+
=============================================
4+
Edit the Private Endpoint for a {+dl+}
5+
=============================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
16+
MongoDB supports |aws| private endpoints using the `AWS PrivateLink
17+
<https://aws.amazon.com/privatelink/>`__ feature only for your {+dl+}s.
18+
You can edit the comment associated with a private endpoint for {+dl+}s
19+
from the |service| User Interface and |api|.
20+
21+
Edit Private Endpoint Through the User Interface
22+
------------------------------------------------
23+
24+
To edit the comment associated with a private endpoint from your
25+
|service| UI:
26+
27+
.. include:: /includes/steps/edit-privatelink.rst
28+
29+
Edit Private Endpoint Through the API
30+
-------------------------------------
31+
32+
To edit a private endpoint through the |api|, send a ``POST`` request
33+
to the :ref:`privateNetworkSettings <adl-api>` endpoint with the unique
34+
ID of the private endpoint to edit. If there is no change to the
35+
comment associated with the specified endpoint, |service| makes no
36+
change to the endpoint ID list. If there is a change to the comment
37+
associated with the specified endpoint, |service| updates the
38+
``comment`` value only in the endpoint ID list.
39+
40+
To learn more about the |api| syntax and options, see
41+
:ref:`api-pvt-link-create-one`.

‎source/admin/manage-private-endpoint.txt

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _manage-private-endpoint:
2+
3+
========================
4+
Manage Private Endpoints
5+
========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
You can set up, view, edit, and delete private endpoints from the
16+
|service| UI {+adl+} and API.
17+
18+
.. toctree::
19+
:titlesonly:
20+
:hidden:
21+
22+
/tutorial/config-private-endpoint
23+
/admin/view-private-endpoints
24+
/admin/edit-private-endpoint
25+
/admin/delete-private-endpoint

‎source/admin/view-private-endpoints.txt

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
.. _view-private-endpoint:
2+
3+
==================================
4+
View the List of Private Endpoints
5+
==================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
You can view the list of private endpoints for the {+dl+}s through the
16+
|service| UI and |api|.
17+
18+
.. _view-pvt-endpoints-ui:
19+
20+
View List of Private Endpoints Using the UI
21+
-------------------------------------------
22+
23+
To view the list of private endpoints from the |service| UI:
24+
25+
.. include:: /includes/steps/view-privatelink.rst
26+
27+
The page displays the private endpoints for your {+dl+}s. For each
28+
private endpoint, you can see the following information:
29+
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 30 70
33+
34+
* - Column Name
35+
- Description
36+
37+
* - :guilabel:`VPC Endpoint ID`
38+
- The unique identifier of the peer |aws| |vpc|. This corresponds
39+
to the value on the |vpc| dashboard in your |aws| account.
40+
41+
* - :guilabel:`Comment`
42+
- The comment associated with the endpoint.
43+
44+
* - :guilabel:`Actions`
45+
- The actions you can take on the private endpoint. You can:
46+
47+
- :ref:`edit-private-endpoint`
48+
- :ref:`delete-private-endpoint`
49+
50+
.. _view-pvt-endpoints-get-one-api:
51+
52+
Retrieve Private Endpoint Using the API
53+
---------------------------------------
54+
55+
To retrieve a private endpoint through the |api|, send a ``GET``
56+
request to the :ref:`privateNetworkSettings/endpointIds/ <adl-api>`
57+
endpoint with the ID of the private endpoint to retrieve. To learn more
58+
about the |api| syntax and options, see
59+
:ref:`api-online-archive-pvt-link-get-one`.
60+
61+
.. _view-pvt-endpoints-get-all-api:
62+
63+
Retrieve All Private Endpoints Using the API
64+
--------------------------------------------
65+
66+
To retrieve all the private endpoints using the |api|, send a ``GET``
67+
request to the :ref:`privateNetworkSettings/endpointIds <adl-api>`
68+
endpoint. To learn more about the syntax and options, see
69+
:ref:`api-online-archive-pvt-link-get-all`.

‎source/administration.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@ This section contains the following:
2121
/config/manage-dbs-cli
2222
/config/manage-collections-views-cli
2323
/admin/manage-namespace-catalog-cli
24+
/admin/manage-private-endpoint
2425
/config/update-region

‎source/includes/list-table-sample-data.rst

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

‎source/includes/steps-add-existing-privatelink.yaml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
ref: network-access
2+
level: 5
3+
stepnum: 0
4+
inherit:
5+
file: steps-source-privatelink.yaml
6+
ref: project-nav-nw-access-page
7+
---
8+
ref: add-private-endpoint
9+
level: 5
10+
stepnum: 0
11+
inherit:
12+
file: steps-source-privatelink.yaml
13+
ref: create-private-endpoint
14+
content: |
15+
16+
{{dl}}
17+
18+
---
19+
ref: add-resource-button
20+
level: 5
21+
stepnum: 0
22+
inherit:
23+
file: steps-source-privatelink.yaml
24+
ref: click-resource-button
25+
content: |
26+
27+
{{dlAdd}}
28+
29+
---
30+
ref: specify-vps-endpoint-id
31+
level: 5
32+
stepnum: 0
33+
title: "Enter your :guilabel:`VPC Endpoint ID`."
34+
content: |
35+
Enter the 22-character alphanumeric string that identifies your
36+
private endpoint. Find this value on the |aws| VPC Dashboard under
37+
:guilabel:`Endpoints` > :guilabel:`VPC ID`.
38+
39+
.. tip::
40+
41+
Click and expand :guilabel:`Show more instructions` in the dialog
42+
for a visual clue as to where you can find the necessary
43+
information in the |aws| console.
44+
---
45+
ref: add-comment-for-vps-endpoint-id
46+
level: 5
47+
stepnum: 0
48+
optional: true
49+
title: "Add a comment to associate with this endpoint."
50+
content: |
51+
You can enter your subnet ID, |vpc| ID, |aws| region, and other
52+
information to associate with this endpoint here.
53+
---
54+
ref: click-confirm
55+
level: 4
56+
stepnum: 0
57+
title: "Click :guilabel:`Confirm` to add the existing private endpoint."
58+
...

‎source/includes/steps-config-connection-type.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
ref: click-adl-connect-button
2+
level: 4
3+
source:
4+
file: steps-connect-shell.yaml
5+
ref: getting-started-connect-dialog
6+
---
7+
ref: nav-to-dl
8+
level: 4
9+
title: "Choose the type of connection that you wish to configure."
10+
content: |
11+
You can choose one of the following options:
12+
13+
- :guilabel:`Standard connection` - to configure this type of
14+
connection, you must do the following:
15+
16+
1. :ref:`add-ip-address`
17+
#. :ref:`create-mdb-user`
18+
19+
- :guilabel:`Private endpoint` - to configure this type of
20+
connection, you must do the following:
21+
22+
#. :ref:`config-private-endpoint`
23+
#. :ref:`create-mdb-user`
24+
25+
.. note::
26+
27+
If you specify ``0.0.0.0`` in your project :atlas:`IP access
28+
list </security/ip-access-list/>`, |service| will accept all
29+
connections including those over PrivateLink.
30+
31+
...

0 commit comments

Comments
 (0)