JENKINS-72643: Fixed listing regions when using ec2 ARN role with instance profile #957
Conversation
This file contains 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
…credentials In the case where a user specified an ARN Role in the advanced section of cloud config we need to use that information when pulling the list of regions. In my case without this ARN Role being used with credentials I would get an empty drop-down list with no errors. I added a log message with the exception to expose a bit of information in case of failures.
craigcomstock
commented
Mar 26, 2024
| @@ -185,14 +185,20 @@ public FormValidation doCheckAltEC2Endpoint(@QueryParameter String value) { | |||
| public ListBoxModel doFillRegionItems( | |||
| @QueryParameter String altEC2Endpoint, | |||
| @QueryParameter boolean useInstanceProfileForCredentials, | |||
| @QueryParameter String roleArn, | |||
| @QueryParameter String roleSessionName, | |||
| @QueryParameter String region, | |||
| @QueryParameter String credentialsId) | |||
|
|
|||
| throws IOException, ServletException { | |||
| ListBoxModel model = new ListBoxModel(); | |||
| if (Jenkins.get().hasPermission(Jenkins.ADMINISTER)) { | |||
| try { | |||
| AWSCredentialsProvider credentialsProvider = createCredentialsProvider(useInstanceProfileForCredentials, | |||
There was a problem hiding this comment.
as far as I can tell from EC2Cloud.java my use here should be OK because there is a guard for empty roleArn and roleSessionName
if (StringUtils.isNotEmpty(roleArn) && StringUtils.isNotEmpty(roleSessionName)) {
return new STSAssumeRoleSessionCredentialsProvider.Builder(roleArn, roleSessionName)
...
craigcomstock
commented
Mar 27, 2024
| @@ -201,6 +207,7 @@ public ListBoxModel doFillRegionItems( | |||
| model.add(name, name); | |||
| } | |||
| } catch (SdkClientException ex) { | |||
| LOGGER.log(Level.INFO, "AmazonEC2Cloud.doFillRegionItems() got exception: " + ex); | |||
There was a problem hiding this comment.
I was thinking I would change this message to incorporate the comment about this may happen before credentials are specified so maybe "OK".
Can we write unit tests which check for logging? The logging would have been VERY helpful to me initially when I encountered this issue.
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.
In the case where a user specified an ARN Role in the advanced section of cloud config we need to use that information when pulling the list of regions.
In my case without this ARN Role being used with credentials I would get an empty drop-down list with no errors.
I added a log message with the exception to expose a bit of information in case of failures.
Testing done
I did test with an ARN Role in the advanced section of cloud config.
I did not (yet) test without this but will do this next. I suppose I could check if roleArn is empty/null and use a different createCredentialsProvider() signature.
I did not see an existing test involving ec2 instance profile or listing regions so did not add one.
Submitter checklist