Add opensearch-java client support

[reta]

Description

Add opensearch-java client support

Issues Resolved

Closes #19

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[calvinch]

Any idea when this PR will be merged?

[reta]

Any idea when this PR will be merged?

@calvinch I will resume the work next week, needs new client favour + tests

[reta]

@dblock I am wondering if you could help me getting this one in, 🙇

[dblock]

I took a very cursory look at this and it LGTM, YOLO.

[dblock]

Nit: remove "At the moment, ", doesn't add any value, it's just documentation.

[dblock]

Latest is 2.14.0, any reason why it's 2.11?

[reta]

This is the last version before requiring the mandatory password, the command line changed

[dblock]

Have a bug on upgrading?

[reta]

Have a bug on upgrading?

Not really, but command line change, so "defaults" won't work anymore

[dblock]

Maybe just use :latest?

[reta]

I would afraid to go with latest since we have changes that may prevent container from starting

[Neuw84]

Will update the sample integration with SpringBoot that I have as soon as we have this on maven central:

https://github.com/aws-samples/opensearch-bootful

Thanks for this!

[Neuw84]

Hi @reta,

One question, apart from the opensearch-bootful I am working on release another sample with knn index and for that I need this to work on opensearch-java client.

I have configured the starter as needed via the exclusion of the old client.

            <groupId>org.opensearch.client</groupId>
            <artifactId>spring-data-opensearch</artifactId>
            <version>1.5.0</version>
            <exclusions>
                <exclusion>
                    <groupId>org.opensearch.client</groupId>
                    <artifactId>opensearch-rest-high-level-client</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.opensearch.client</groupId>
            <artifactId>opensearch-java</artifactId>
            <version>2.11.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.httpcomponents.client5</groupId>
            <artifactId>httpclient5</artifactId>
            <version>5.3.1</version>
        </dependency>

but then, I don´t know how to configure the client for spring-data as AbstractOpenSearchConfiguration is expecting a RestHighLevelClient. My class using the old client was this one.

@Configuration
@EnableElasticsearchRepositories(basePackages = "com.aws.samples.opensearch.repository")
@Slf4j
public class OpenSearchRestClientConfiguration extends AbstractOpenSearchConfiguration {

  @Value("${aws.os.endpoint}")
  private String endpoint = "";

  @Value("${aws.os.region}")
  private String region = "";

  @Value("${aws.os.username}")
  private String username = "";

  @Value("${aws.os.password}")
  private String password = "";



  @Override
  @Bean
  public RestHighLevelClient opensearchClient() {

    final ClientConfiguration clientConfiguration =
        ClientConfiguration.builder()
            .connectedTo(endpoint)
            .usingSsl()
            .withBasicAuth(username,password)
            .withConnectTimeout(Duration.ofSeconds(10))
            .withSocketTimeout(Duration.ofSeconds(5))
            .build();
    return RestClients.create(clientConfiguration).rest();
  }
}

Any hints?

Thanks!!

[reta]

but then, I don´t know how to configure the client for spring-data as AbstractOpenSearchConfiguration is expecting a RestHighLevelClient. My class using the old client was this one.

Hi @Neuw84 ,

You just need to replace AbstractOpenSearchConfiguration with org.opensearch.data.client.osc.OpenSearchConfiguration, for example:

@Configuration
@EnableElasticsearchRepositories(basePackages = "com.aws.samples.opensearch.repository")
@Slf4j
public class OpenSearchClientConfiguration extends OpenSearchConfiguration {

        @Value("${aws.os.endpoint}")
        private String endpoint = "";
      
        @Value("${aws.os.region}")
        private String region = "";
      
        @Value("${aws.os.username}")
        private String username = "";
      
        @Value("${aws.os.password}")
        private String password = "";

       @NonNull
        @Override
        public ClientConfiguration clientConfiguration() {
            return  ClientConfiguration.builder()
                    .connectedTo(endpoint)
                    .usingSsl()
                    .withBasicAuth(username,password)
                    .withConnectTimeout(Duration.ofSeconds(10))
                    .withSocketTimeout(Duration.ofSeconds(5))
                    .build();
        }
}

[Neuw84]

Thanks for the super quick reply, got it!