Skip to content

DOCSP-32752 Support for setting AWS region #958

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Feb 6, 2025

Conversation

lindseymoore
Copy link
Collaborator

@lindseymoore lindseymoore commented Feb 3, 2025

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-32752
Staging - https://deploy-preview-958--docs-node.netlify.app/fundamentals/authentication/mechanisms/#mongodb-aws
(Note in the Web Identity Token tab)

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?
  • Are the facets and meta keywords accurate?

Copy link

netlify bot commented Feb 3, 2025

Deploy Preview for docs-node ready!

Name Link
🔨 Latest commit 5368fd2
🔍 Latest deploy log https://app.netlify.com/sites/docs-node/deploys/67a4ffef0568920008d43447
😎 Deploy Preview https://deploy-preview-958--docs-node.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@rachel-mack rachel-mack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be incorporated a little differently:

@@ -234,6 +234,23 @@ The driver checks for your credentials in the following sources in order:
.. literalinclude:: /code-snippets/authentication/aws-env-variable.js
:language: javascript

.. note:: How to Set the AWS Region for Regional Endpoints
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move this to line 230 and not make it a note. I would also include a code block:

export AWS_STS_REGIONAL_ENDPOINTS=regional //enable regional endpoints
export AWS_REGION=us-east-2 //select your AWS region

Looking at the JIRA ticket, it looks like we should specify that the default region is us-east-1.

Copy link
Collaborator Author

@lindseymoore lindseymoore Feb 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The restructuring makes sense, thanks! Before you take another look, I'll ask the technical reviewer to confirm the default region and whether global endpoints are available for this feature (in which case I would delete the first sentence about why to use regional endpoints).

@lindseymoore
Copy link
Collaborator Author

For the technical reviewer, can you confirm the following:

  • Is us-east-1 the default region if both region environment variables aren't set?
  • Does this authentication only use regional endpoints? In which case, I will delete the first sentence talking about the benefits of using regional endpoints.
    Thank you!

Copy link
Collaborator

@nbbeeken nbbeeken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the warning LGTM!

Yes us-east-1 is the default if neither are set.

Auth does not always use your region's endpoint (then us-east-1 would not be the default, your current region would be). So the first sentence should be kept because it is an improvement to enable this :) ty again

@lindseymoore lindseymoore merged commit 65f4f5c into mongodb:master Feb 6, 2025
5 checks passed
github-actions bot pushed a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)
github-actions bot pushed a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)
github-actions bot pushed a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)
github-actions bot pushed a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)
github-actions bot pushed a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)
github-actions bot pushed a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
lindseymoore added a commit that referenced this pull request Feb 25, 2025
* DOCSP-32752 Suppor for setting AWS region

* edits

* merge

* another merge attempt

* edit

* edit on title

* RM review

* update links

* default region

* tech review note

* change wanring msg

* wording changed

* change link

(cherry picked from commit 65f4f5c)

Co-authored-by: lindseymoore <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants