Skip to content

[OpenSearch] Updated transport settings, fix auth to multiple hosts #3007

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[OpenSearch] Updated transport settings, fix auth to multiple hosts #3007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 65 additions & 19 deletions ...ework/ai/vectorstore/opensearch/autoconfigure/OpenSearchVectorStoreAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,19 @@
package org.springframework.ai.vectorstore.opensearch.autoconfigure;

import java.net.URISyntaxException;
import java.time.Duration;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.TimeUnit;

import io.micrometer.observation.ObservationRegistry;
import org.apache.hc.client5.http.auth.AuthScope;
import org.apache.hc.client5.http.auth.UsernamePasswordCredentials;
import org.apache.hc.client5.http.config.RequestConfig;
import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider;
import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder;
import org.apache.hc.client5.http.nio.AsyncClientConnectionManager;
import org.apache.hc.client5.http.ssl.ClientTlsStrategyBuilder;
import org.apache.hc.core5.http.HttpHost;
import org.opensearch.client.opensearch.OpenSearchClient;
import org.opensearch.client.transport.OpenSearchTransport;
Expand All @@ -33,7 +39,6 @@
import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
import software.amazon.awssdk.http.SdkHttpClient;
import software.amazon.awssdk.http.apache.ApacheHttpClient;
import software.amazon.awssdk.regions.Region;

Expand All @@ -50,6 +55,7 @@
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.ssl.SslBundles;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.StringUtils;
Expand Down Expand Up @@ -100,26 +106,57 @@ static class OpenSearchConfiguration {

@Bean
@ConditionalOnMissingBean
OpenSearchClient openSearchClient(OpenSearchConnectionDetails connectionDetails) {
HttpHost[] httpHosts = connectionDetails.getUris()
.stream()
.map(s -> createHttpHost(s))
.toArray(HttpHost[]::new);
ApacheHttpClient5TransportBuilder transportBuilder = ApacheHttpClient5TransportBuilder.builder(httpHosts);
Optional.ofNullable(connectionDetails.getUsername())
.map(username -> createBasicCredentialsProvider(httpHosts[0], username,
connectionDetails.getPassword()))
.ifPresent(basicCredentialsProvider -> transportBuilder
.setHttpClientConfigCallback(httpAsyncClientBuilder -> httpAsyncClientBuilder
.setDefaultCredentialsProvider(basicCredentialsProvider)));
OpenSearchClient openSearchClient(OpenSearchVectorStoreProperties properties, Optional<SslBundles> sslBundles) {
HttpHost[] httpHosts = properties.getUris().stream().map(this::createHttpHost).toArray(HttpHost[]::new);
Optional<BasicCredentialsProvider> basicCredentialsProvider = Optional.ofNullable(properties.getUsername())
.map(username -> createBasicCredentialsProvider(httpHosts, username, properties.getPassword()));

var transportBuilder = ApacheHttpClient5TransportBuilder.builder(httpHosts);
transportBuilder.setHttpClientConfigCallback(httpClientBuilder -> {
basicCredentialsProvider.ifPresent(httpClientBuilder::setDefaultCredentialsProvider);
httpClientBuilder.setConnectionManager(createConnectionManager(properties, sslBundles));
httpClientBuilder.setDefaultRequestConfig(createRequestConfig(properties));
return httpClientBuilder;
});

return new OpenSearchClient(transportBuilder.build());
}

private BasicCredentialsProvider createBasicCredentialsProvider(HttpHost httpHost, String username,
private AsyncClientConnectionManager createConnectionManager(OpenSearchVectorStoreProperties properties,
Optional<SslBundles> sslBundles) {
var connectionManagerBuilder = PoolingAsyncClientConnectionManagerBuilder.create();
if (sslBundles.isPresent()) {
Optional.ofNullable(properties.getSslBundle())
.map(bundle -> sslBundles.get().getBundle(bundle))
.map(bundle -> ClientTlsStrategyBuilder.create()
.setSslContext(bundle.createSslContext())
.setTlsVersions(bundle.getOptions().getEnabledProtocols())
.build())
.ifPresent(connectionManagerBuilder::setTlsStrategy);
}
return connectionManagerBuilder.build();
}

private RequestConfig createRequestConfig(OpenSearchVectorStoreProperties properties) {
var requestConfigBuilder = RequestConfig.custom();
Optional.ofNullable(properties.getConnectionTimeout())
.map(Duration::toMillis)
.ifPresent(timeoutMillis -> requestConfigBuilder.setConnectionRequestTimeout(timeoutMillis,
TimeUnit.MILLISECONDS));
Optional.ofNullable(properties.getReadTimeout())
.map(Duration::toMillis)
.ifPresent(
timeoutMillis -> requestConfigBuilder.setResponseTimeout(timeoutMillis, TimeUnit.MILLISECONDS));
return requestConfigBuilder.build();
}

private BasicCredentialsProvider createBasicCredentialsProvider(HttpHost[] httpHosts, String username,
String password) {
BasicCredentialsProvider basicCredentialsProvider = new BasicCredentialsProvider();
basicCredentialsProvider.setCredentials(new AuthScope(httpHost),
new UsernamePasswordCredentials(username, password.toCharArray()));
for (HttpHost httpHost : httpHosts) {
basicCredentialsProvider.setCredentials(new AuthScope(httpHost),
new UsernamePasswordCredentials(username, password.toCharArray()));
}
return basicCredentialsProvider;
}

Expand Down Expand Up @@ -147,12 +184,21 @@ PropertiesAwsOpenSearchConnectionDetails awsOpenSearchConnectionDetails(

@Bean
@ConditionalOnMissingBean
OpenSearchClient openSearchClient(OpenSearchVectorStoreProperties properties,
OpenSearchClient openSearchClient(OpenSearchVectorStoreProperties properties, Optional<SslBundles> sslBundles,
AwsOpenSearchConnectionDetails connectionDetails, AwsSdk2TransportOptions options) {
Region region = Region.of(connectionDetails.getRegion());

SdkHttpClient httpClient = ApacheHttpClient.builder().build();
OpenSearchTransport transport = new AwsSdk2Transport(httpClient,
var httpClientBuilder = ApacheHttpClient.builder();
Optional.ofNullable(properties.getConnectionTimeout()).ifPresent(httpClientBuilder::connectionTimeout);
Optional.ofNullable(properties.getReadTimeout()).ifPresent(httpClientBuilder::socketTimeout);
if (sslBundles.isPresent()) {
Optional.ofNullable(properties.getSslBundle())
.map(bundle -> sslBundles.get().getBundle(bundle))
.ifPresent(bundle -> httpClientBuilder
.tlsKeyManagersProvider(() -> bundle.getManagers().getKeyManagers())
.tlsTrustManagersProvider(() -> bundle.getManagers().getTrustManagers()));
}
OpenSearchTransport transport = new AwsSdk2Transport(httpClientBuilder.build(),
connectionDetails.getHost(properties.getAws().getDomainName()),
properties.getAws().getServiceName(), region, options);
return new OpenSearchClient(transport);
Expand Down
39 changes: 38 additions & 1 deletion ...ingframework/ai/vectorstore/opensearch/autoconfigure/OpenSearchVectorStoreProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2023-2024 the original author or authors.
* Copyright 2023-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -16,6 +16,7 @@

package org.springframework.ai.vectorstore.opensearch.autoconfigure;

import java.time.Duration;
import java.util.List;

import org.springframework.ai.vectorstore.properties.CommonVectorStoreProperties;
Expand All @@ -39,6 +40,18 @@ public class OpenSearchVectorStoreProperties extends CommonVectorStoreProperties

private String mappingJson;

/**
* SSL Bundle name ({@link org.springframework.boot.ssl.SslBundles}).
*/
private String sslBundle;

/**
*
*/
private Duration connectionTimeout;

private Duration readTimeout;

private Aws aws = new Aws();

public List<String> getUris() {
Expand Down Expand Up @@ -81,6 +94,30 @@ public void setMappingJson(String mappingJson) {
this.mappingJson = mappingJson;
}

public String getSslBundle() {
return sslBundle;
}

public void setSslBundle(String sslBundle) {
this.sslBundle = sslBundle;
}

public Duration getConnectionTimeout() {
return connectionTimeout;
}

public void setConnectionTimeout(Duration connectionTimeout) {
this.connectionTimeout = connectionTimeout;
}

public Duration getReadTimeout() {
return readTimeout;
}

public void setReadTimeout(Duration readTimeout) {
this.readTimeout = readTimeout;
}

public Aws getAws() {
return this.aws;
}
Expand Down
15 changes: 15 additions & 0 deletions .../ai/vectorstore/opensearch/autoconfigure/AwsOpenSearchVectorStoreAutoConfigurationIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import org.awaitility.Awaitility;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.opensearch.client.opensearch.OpenSearchClient;
import org.testcontainers.containers.localstack.LocalStackContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
Expand All @@ -37,8 +38,11 @@
import org.springframework.ai.retry.autoconfigure.SpringAiRetryAutoConfiguration;
import org.springframework.ai.transformers.TransformersEmbeddingModel;
import org.springframework.ai.vectorstore.SearchRequest;
import org.springframework.ai.vectorstore.VectorStore;
import org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.autoconfigure.ssl.SslAutoConfiguration;
import org.springframework.boot.ssl.SslBundles;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
Expand Down Expand Up @@ -138,6 +142,17 @@ public void addAndSearchTest() {
});
}

@Test
public void autoConfigurationWithSslBundles() {
this.contextRunner.withConfiguration(AutoConfigurations.of(SslAutoConfiguration.class)).run(context -> {
assertThat(context.getBeansOfType(SslBundles.class)).isNotEmpty();
assertThat(context.getBeansOfType(OpenSearchClient.class)).isNotEmpty();
assertThat(context.getBeansOfType(OpenSearchVectorStoreProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(VectorStore.class)).isNotEmpty();
assertThat(context.getBean(VectorStore.class)).isInstanceOf(OpenSearchVectorStore.class);
});
}

private String getText(String uri) {
var resource = new DefaultResourceLoader().getResource(uri);
try {
Expand Down
14 changes: 14 additions & 0 deletions ...ork/ai/vectorstore/opensearch/autoconfigure/OpenSearchVectorStoreAutoConfigurationIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import io.micrometer.observation.tck.TestObservationRegistry;
import org.awaitility.Awaitility;
import org.junit.jupiter.api.Test;
import org.opensearch.client.opensearch.OpenSearchClient;
import org.opensearch.testcontainers.OpensearchContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
Expand All @@ -42,6 +43,8 @@
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
import org.springframework.ai.vectorstore.opensearch.OpenSearchVectorStore;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.autoconfigure.ssl.SslAutoConfiguration;
import org.springframework.boot.ssl.SslBundles;
import org.springframework.boot.test.context.FilteredClassLoader;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean;
Expand Down Expand Up @@ -170,6 +173,17 @@ public void autoConfigurationEnabledWhenTypeIsOpensearch() {
});
}

@Test
public void autoConfigurationWithSslBundles() {
this.contextRunner.withConfiguration(AutoConfigurations.of(SslAutoConfiguration.class)).run(context -> {
assertThat(context.getBeansOfType(SslBundles.class)).isNotEmpty();
assertThat(context.getBeansOfType(OpenSearchClient.class)).isNotEmpty();
assertThat(context.getBeansOfType(OpenSearchVectorStoreProperties.class)).isNotEmpty();
assertThat(context.getBeansOfType(VectorStore.class)).isNotEmpty();
assertThat(context.getBean(VectorStore.class)).isInstanceOf(OpenSearchVectorStore.class);
});
}

private String getText(String uri) {
var resource = new DefaultResourceLoader().getResource(uri);
try {
Expand Down