docs(credential-provider-node): correct example code for EKS IAM roles #2909
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
The example code for EKS roles in the `credential-provider-node` README incorrectly passes the `getDefaultRoleAssumerWithWebIdentity` function itself as the `roleAssumerWithWebIdentity` when setting up the default provider. Instead, it should be calling this function and passing the returned value instead (also a function).
This comment was marked as outdated.
This comment was marked as outdated.
scottybrisbane
changed the title
trivikr
changed the title
siddsriv
approved these changes
Aug 9, 2023
|
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Issue
N/A
Description
The example code for EKS roles in the
credential-provider-nodeREADME currently passes thegetDefaultRoleAssumerWithWebIdentityfunction itself as theroleAssumerWithWebIdentitywhen setting up the default credentials provider. Instead, it should be calling this function and passing the returned value (also a function).Testing
The current example code does not work as intended. By instead calling the
getDefaultRoleAssumerWithWebIdentityand passing its returned value asroleAssumerWithWebIdentity, I was able to get a working example going.Additional context
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.