Skip to content

DOCSP-26403: changes to aws credential retrieval #691

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 4 commits into from
May 19, 2023

Conversation

rustagir
Copy link
Collaborator

Pull Request Info

PR Reviewing Guidelines

JIRA - DOCSP-26403
Staging:

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?

Copy link
Contributor

@DBirtolo-mdb DBirtolo-mdb left a comment

Choose a reason for hiding this comment

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

Nice work! Just a couple of small questions/items.

Comment on lines 242 to 247
to retrieve credentials from the environment. As a result, if you
have a shared AWS credentials file or config file, the driver will
use those credentials by default if there are no AWS authentication
environment variables set.

To override this behavior, you can perform one of the following actions:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion

I think this sentence is a little long and covers a couple of ideas, so I would recommend breaking it into two different sentences and combining it with the next line. I also reworded the second sentence a bit to put the actionable part first.

Suggested change
to retrieve credentials from the environment. As a result, if you
have a shared AWS credentials file or config file, the driver will
use those credentials by default if there are no AWS authentication
environment variables set.
To override this behavior, you can perform one of the following actions:
to retrieve credentials from the environment. As a result, if you
have a shared AWS credentials file or config file, the driver will
use those credentials by default. You can override this behavior
by performing one of the following actions:

Comment on lines 249 to 250
- Set ``AWS_SHARED_CREDENTIALS_FILE`` in your shell or set the
equivalent environment variable value in your application.
Copy link
Contributor

Choose a reason for hiding this comment

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

Question

Set it to what? I am assuming it is the full path to the credential file, but think it would be helpful to specify this for the reader.

equivalent environment variable value in your application.
- Create an AWS profile for your MongoDB credentials and set the
``AWS_PROFILE`` environment variable to that profile name.

Copy link
Contributor

Choose a reason for hiding this comment

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

Question

What if you do both of these options? Which one has precedence? Might be beyond the scope or not something you can answer, but was a thought that came to mind.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, it might be out of scope. I'm not sure what the order is


Mutually Recursive Schema Type Checking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This release also includes added support for **mutually
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion

Given how you've restructured this beginning, the "also" here seems out of place and that it doesn't flow well.

Suggested change
This release also includes added support for **mutually
This release includes added support for **mutually

@rustagir rustagir requested a review from DBirtolo-mdb May 19, 2023 15:09
Copy link
Contributor

@DBirtolo-mdb DBirtolo-mdb left a comment

Choose a reason for hiding this comment

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

LGTM!

@rustagir rustagir merged commit 5bcdb61 into mongodb:master May 19, 2023
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
(cherry picked from commit f595e7c)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
(cherry picked from commit f595e7c)
(cherry picked from commit 6c0424f)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
(cherry picked from commit f595e7c)
(cherry picked from commit 6c0424f)
(cherry picked from commit fb7ea11)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
(cherry picked from commit f595e7c)
(cherry picked from commit 6c0424f)
(cherry picked from commit fb7ea11)
rustagir added a commit that referenced this pull request May 19, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1

(cherry picked from commit 5bcdb61)
(cherry picked from commit f595e7c)
(cherry picked from commit 6c0424f)
(cherry picked from commit fb7ea11)
mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023
* DOCSP-26403: changes to aws credential retrieval

* formatting fixes

* capitalization

* DB PR fixes 1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants