Skip to content

HADOOP-19201 S3A. Support external-id in assume role #6876

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.

Sign up for GitHub

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
steveloughran merged 5 commits into from
Sep 10, 2024
+18 −0
Merged

HADOOP-19201 S3A. Support external-id in assume role #6876

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e17cdab
Support external-id in assume role
Smith-Cruise Jun 8, 2024
d443ac7
update doc
Smith-Cruise Aug 30, 2024
b4a6ba5
update doc
Smith-Cruise Aug 30, 2024
d68a856
update doc
Smith-Cruise Aug 31, 2024
d75fb47
improve
Smith-Cruise Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions hadoop-common-project/hadoop-common/src/main/resources/core-default.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1457,6 +1457,14 @@
</description>
</property>

<property>

@steveloughran steveloughran Aug 30, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lets actually cut this. Adding default values here increases the size of the configuration when marshalling, which happens a lot these days.

@Smith-Cruise Smith-Cruise Aug 30, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done

<name>fs.s3a.assumed.role.external.id</name>
<value />
<description>
External id for assumed role, it's an optional configuration.
</description>
</property>

<property>
<name>fs.s3a.assumed.role.policy</name>
<value/>
Expand Down
5 changes: 5 additions & 0 deletions hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ private Constants() {
public static final String ASSUMED_ROLE_ARN =
"fs.s3a.assumed.role.arn";

/**
* external id for assume role request: {@value}.
*/
public static final String ASSUMED_ROLE_EXTERNAL_ID = "fs.s3a.assumed.role.external.id";

/**
* Session name for the assumed role, must be valid characters according
* to the AWS APIs: {@value}.
Expand Down
5 changes: 5 additions & 0 deletions ...hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/auth/AssumedRoleCredentialProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,13 +125,18 @@ public AssumedRoleCredentialProvider(@Nullable URI fsUri, Configuration conf)
duration = conf.getTimeDuration(ASSUMED_ROLE_SESSION_DURATION,
ASSUMED_ROLE_SESSION_DURATION_DEFAULT, TimeUnit.SECONDS);
String policy = conf.getTrimmed(ASSUMED_ROLE_POLICY, "");
String externalId = conf.getTrimmed(ASSUMED_ROLE_EXTERNAL_ID, "");

LOG.debug("{}", this);

AssumeRoleRequest.Builder requestBuilder =
AssumeRoleRequest.builder().roleArn(arn).roleSessionName(sessionName)
.durationSeconds((int) duration);

if (StringUtils.isNotEmpty(externalId)) {
requestBuilder.externalId(externalId);
}

if (StringUtils.isNotEmpty(policy)) {
LOG.debug("Scope down policy {}", policy);
requestBuilder.policy(policy);
Expand Down
8 changes: 8 additions & 0 deletions hadoop-tools/hadoop-aws/src/site/markdown/tools/hadoop-aws/assumed_roles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,14 @@ Here are the full set of configuration options.
</description>
</property>

<property>
<name>fs.s3a.assumed.role.external.id</name>
<value />

@steveloughran steveloughran Aug 30, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

can you an a valid example

@Smith-Cruise Smith-Cruise Aug 30, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

What do you mean? Put an example value here?

@steveloughran steveloughran Aug 30, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yes.

@Smith-Cruise Smith-Cruise Aug 31, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think putting an example here is meaningless, because external id is just a string set by the user, it can by any value. No unified format.

@steveloughran steveloughran Sep 9, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

so make that clear, e.g

<value>arbitrary value</value

<description>
External id for assumed role, it's an optional configuration.
</description>
Comment thread
steveloughran marked this conversation as resolved.
</property>

<property>
<name>fs.s3a.assumed.role.policy</name>
<value/>
Expand Down