Skip to content

Commit e79a836

Browse files
authored
doc: Add link to multi-region private endpoint troubleshooting (#3273)
* doc: Add link to multi-region private endpoint troubleshooting * MS feedback
1 parent 8bf272c commit e79a836

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

docs/data-sources/privatelink_endpoint.md

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
-> **NOTE:** Groups and projects are synonymous terms. You may find group_id in the official documentation.
66

7+
~> **IMPORTANT:** Before configuring a private endpoint for a new region in your cluster,
8+
ensure that you review the [Multi-Region Private Endpoints](https://www.mongodb.com/docs/atlas/troubleshoot-private-endpoints/#multi-region-private-endpoints) troubleshooting documentation.
9+
710
## Example Usage
811

912
```terraform

docs/resources/privatelink_endpoint.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,21 @@
22

33
`mongodbatlas_privatelink_endpoint` provides a Private Endpoint resource. This represents a [Private Endpoint Service](https://www.mongodb.com/docs/atlas/security-private-endpoint/#private-endpoint-concepts) that can be created in an Atlas project.
44

5-
> **IMPORTANT:** This resource creates a Private Endpoint *Service* in MongoDB Atlas. The endpoint itself is created in your cloud provider using the information returned by this resource. The complementary resource `mongodbatlas_privatelink_endpoint_service` is used to link your cloud provider's endpoint to the Atlas service.
5+
~> **IMPORTANT:** This resource creates a Private Endpoint *Service* in MongoDB Atlas. The endpoint itself is created in your cloud provider using the information returned by this resource. The complementary resource `mongodbatlas_privatelink_endpoint_service` is used to link your cloud provider's endpoint to the Atlas service.
66

77
The [private link Terraform module](https://registry.terraform.io/modules/terraform-mongodbatlas-modules/private-endpoint/mongodbatlas/latest) makes use of this resource and simplifies its use.
88

99
~> **IMPORTANT:**You must have one of the following roles to successfully handle the resource:
10-
* Organization Owner
11-
* Project Owner
10+
* Organization Owner
11+
* Project Owner
12+
13+
~> **IMPORTANT:** Before configuring a private endpoint for a new region in your cluster,
14+
ensure that you review the [Multi-Region Private Endpoints](https://www.mongodb.com/docs/atlas/troubleshoot-private-endpoints/#multi-region-private-endpoints) troubleshooting documentation.
1215

1316
-> **NOTE:** Groups and projects are synonymous terms. You may find group_id in the official documentation.
1417

1518
-> **NOTE:** A network container is created for a private endpoint to reside in if one does not yet exist in the project.
1619

17-
1820
## Example Usage
1921

2022
```terraform

0 commit comments

Comments
 (0)