doc: Add link to multi-region private endpoint troubleshooting #3273
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcosuma
reviewed
Apr 14, 2025
| @@ -2,18 +2,21 @@ | |||
|
|
|||
| `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. | |||
|
|
|||
| > **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. | |||
| -> **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. | |||
There was a problem hiding this comment.
thanks for the fix!! Would you please actually use the ~, that's the symbol to get the colored warning box
Suggested change
| -> **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. | |
| ~> **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. |
marcosuma
reviewed
Apr 14, 2025
|
|
||
| -> **NOTE:** Groups and projects are synonymous terms. You may find group_id in the official documentation. | ||
|
|
||
| -> **NOTE:** A network container is created for a private endpoint to reside in if one does not yet exist in the project. | ||
|
|
||
| -> **IMPORTANT:** You might encounter errors after configuring a private endpoint for a new |
There was a problem hiding this comment.
Suggested change
| -> **IMPORTANT:** You might encounter errors after configuring a private endpoint for a new | |
| ~> **IMPORTANT:** You might encounter errors after configuring a private endpoint for a new |
There was a problem hiding this comment.
Could you please put this IMPORTANT before the two NOTEs? Thank you!
marcosuma
reviewed
Apr 14, 2025
marcosuma
reviewed
Apr 14, 2025
Comment on lines
7
to
10
| -> **IMPORTANT:** You might encounter errors after configuring a private endpoint for a new | ||
| region in your cluster. To learn how to troubleshoot potential errors, see | ||
| [Multi-Region Private Endpoints](https://www.mongodb.com/docs/atlas/troubleshoot-private-endpoints/#multi-region-private-endpoints) in the MongoDB Atlas documentation. | ||
|
|
There was a problem hiding this comment.
Suggested change
| -> **IMPORTANT:** You might encounter errors after configuring a private endpoint for a new | |
| region in your cluster. To learn how to troubleshoot potential errors, see | |
| [Multi-Region Private Endpoints](https://www.mongodb.com/docs/atlas/troubleshoot-private-endpoints/#multi-region-private-endpoints) in the MongoDB Atlas documentation. | |
| -> **IMPORTANT:** If you are adding a new region to your cluster and configuring a private | |
| endpoint for the region, make sure to first review the [Multi-Region Private Endpoints documentation](https://www.mongodb.com/docs/atlas/troubleshoot-private-endpoints/#multi-region-private-endpoints). | |
There was a problem hiding this comment.
I wasn't convinced about mentioning "potential errors" since it could create confusion. So I am proposing this format "to read the doc first if you are..."
There was a problem hiding this comment.
I reworded it to something similar, let me know what you think!
marcosuma
approved these changes
Apr 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds links to new private endpoint troubleshooting information in the docs, requested here in Jira.
Link to any related issue(s): DOCSP-49182
Type of change:
Required Checklist:
Further comments