Skip to content
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

Use alternative ARN as credentials when configured #262

Closed
wants to merge 7 commits into from
Closed

Use alternative ARN as credentials when configured #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
159137e
Add capability to swap FlintSparkConf values based on usage mode
Swiddis Feb 23, 2024
fc5e2a3
Revert "Add capability to swap FlintSparkConf values based on usage m…
Swiddis Feb 23, 2024
f0b33ff
Add repl customAWSCredentialsProvider
Swiddis Feb 23, 2024
da7eca3
Add ARN environment variable for sessionIndex credentials
Swiddis Feb 23, 2024
7ec26d7
Add new session ARN to client construction
Swiddis Feb 24, 2024
3dc0be9
Merge remote-tracking branch 'origin/main' into feature/repl-spark-conf
Swiddis Feb 24, 2024
6ea5e99
Fix unused variable in list
Swiddis Feb 28, 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
4 changes: 4 additions & 0 deletions flint-core/src/main/scala/org/opensearch/flint/core/FlintOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,8 @@ public String getPassword() {
public int getSocketTimeoutMillis() {
return Integer.parseInt(options.getOrDefault(SOCKET_TIMEOUT_MILLIS, String.valueOf(DEFAULT_SOCKET_TIMEOUT_MILLIS)));
}

public String getSessionIndexARN() {
return options.getOrDefault("spark.repl.flint.ASSUME_ROLE_CREDENTIALS_ROLE_ARN", "");
Copy link
Collaborator

Choose a reason for hiding this comment

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

np: use the constant?

}
}
11 changes: 11 additions & 0 deletions flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import static org.opensearch.common.xcontent.DeprecationHandler.IGNORE_DEPRECATIONS;

import com.amazonaws.auth.STSAssumeRoleSessionCredentialsProvider;
import com.amazonaws.auth.AWS4Signer;
import com.amazonaws.auth.AWSCredentialsProvider;
import com.amazonaws.auth.DefaultAWSCredentialsProviderChain;
Expand Down Expand Up @@ -248,7 +249,10 @@ public IRestHighLevelClient createClient() {
// Use DefaultAWSCredentialsProviderChain by default.
final AtomicReference<AWSCredentialsProvider> awsCredentialsProvider =
new AtomicReference<>(new DefaultAWSCredentialsProviderChain());

String providerClass = options.getCustomAwsCredentialsProvider();
String sessionIndexArn = options.getSessionIndexARN();
// If a custom provider class is given, validate sessions with it
if (!Strings.isNullOrEmpty(providerClass)) {
try {
Class<?> awsCredentialsProviderClass = Class.forName(providerClass);
Expand All @@ -258,7 +262,14 @@ public IRestHighLevelClient createClient() {
} catch (Exception e) {
throw new RuntimeException(e);
}
} else if (!Strings.isNullOrEmpty(sessionIndexArn)) { // Otherwise, use a provided ARN if available
// Create a new AssumeRoleAWSCredentialsProvider with the provided ARN
AWSCredentialsProvider assumeRoleProvider = new STSAssumeRoleSessionCredentialsProvider
.Builder(sessionIndexArn, "FlintOpenSearchClient_session")
.build();
awsCredentialsProvider.set(assumeRoleProvider);
}

restClientBuilder.setHttpClientConfigCallback(builder -> {
HttpAsyncClientBuilder delegate =
builder.addInterceptorLast(
Expand Down
10 changes: 9 additions & 1 deletion ...t-spark-integration/src/main/scala/org/apache/spark/sql/flint/config/FlintSparkConf.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,13 @@ object FlintSparkConf {
.doc("AWS customAWSCredentialsProvider")
.createWithDefault(FlintOptions.DEFAULT_CUSTOM_AWS_CREDENTIALS_PROVIDER)

val REPL_FLINT_ASSUME_SESSION_ROLE_ARN =
FlintConfig("spark.repl.flint.ASSUME_ROLE_CREDENTIALS_ROLE_ARN")
.datasourceOption()
.doc("The role to use for writing state information to the session index. " +
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could you update user manual as well? Btw, this doesn't seem to only apply to REPL. It's used by low level Flint client? Should we follow spark.datasource.flint prefix?

"This is used update and read job results or errors, independent of other write permissions for OpenSearch.")
.createOptional()

val DOC_ID_COLUMN_NAME = FlintConfig("spark.datasource.flint.write.id_name")
.datasourceOption()
.doc(
Expand Down Expand Up @@ -230,7 +237,8 @@ case class FlintSparkConf(properties: JMap[String, String]) extends Serializable
DATA_SOURCE_NAME,
SESSION_ID,
REQUEST_INDEX,
EXCLUDE_JOB_IDS)
EXCLUDE_JOB_IDS,
REPL_FLINT_ASSUME_SESSION_ROLE_ARN)
.map(conf => (conf.optionKey, conf.readFrom(reader)))
.flatMap {
case (_, None) => None
Expand Down
Loading