Skip to content

Commit

Permalink
Rename everything from opensearch-sdk to opensearch-sdk-java
Browse files Browse the repository at this point in the history
Signed-off-by: mloufra <[email protected]>
  • Loading branch information
mloufra committed Aug 23, 2022
1 parent 59a47a1 commit 463cdba
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# OpenSearch SDK Java Developer Guide
# OpenSearch SDK for Java Developer Guide
- [Introduction](#introduction)
- [Getting Started](#getting-started)
- [Git Clone OpenSearch-SDK-Java Repo](#git-clone-OpenSearch-SDK-Java-repo)
Expand All @@ -18,14 +18,14 @@ Read more about extensibility [here](https://github.com/opensearch-project/OpenS

## Getting Started

### Git Clone OpenSearch SDK Java Repo
Fork [OpenSearch SDK Java](https://github.com/opensearch-project/opensearch-sdk-java) and clone locally, e.g. `git clone https://github.com/[your username]/opensearch-sdk-java.git`.
### Git Clone OpenSearch SDK for Java Repo
Fork [OpenSearch SDK for Java](https://github.com/opensearch-project/opensearch-sdk-java) and clone locally, e.g. `git clone https://github.com/[your username]/opensearch-sdk-java.git`.

### Git Clone OpenSearch Repo
Fork [OpenSearch](https://github.com/opensearch-project/OpenSearch/), checkout feature/extensions branch, and clone locally, e.g. `git clone https://github.com/[your username]/OpenSearch.git`.

## Publish OpenSearch feature/extensions Branch to Maven local
The work done to support the extensions framework is located on the `feature/extensions` branch of the OpenSearch project. It is necessary to publish the dependencies of this branch to your local maven repository prior to running the OpenSearch SDK Java on a seperate process.
The work done to support the extensions framework is located on the `feature/extensions` branch of the OpenSearch project. It is necessary to publish the dependencies of this branch to your local maven repository prior to running OpenSearch SDK for Java on a seperate process.

- First navigate to the directory that OpenSearch has been cloned to
- Checkout the correct branch, e.g. `git checkout feature/extensions`.
Expand All @@ -34,7 +34,7 @@ The work done to support the extensions framework is located on the `feature/ext

It is necessary to publish dependencies to a local maven repository until this branch is merged to `main`, at which point all dependencies will be published to Maven central.

## Run OpenSearch SDK Java
## Run OpenSearch SDK for Java

Navigate to the directory that OpenSearch-SDK-Java has been cloned to and run main script using `./gradlew run`.

Expand Down Expand Up @@ -92,7 +92,7 @@ extensions:
- Return to the OpenSearch directory by using `cd ..`.
- Start OpenSearch feature/extensions branch using `./bin/opensearch`.

During OpenSearch bootstrap, `ExtensionsOrchestrator` will then discover the extension listenening on a pre-defined port and execute the TCP handshake protocol to establish a data transfer connection. A request will be sent to the OpenSearch SDK Java and upon acknowledgment, the extension will respond with its name which will be logged onto terminal that OpenSearch is running on.
During OpenSearch bootstrap, `ExtensionsOrchestrator` will then discover the extension listenening on a pre-defined port and execute the TCP handshake protocol to establish a data transfer connection. A request will be sent to OpenSearch SDK for Java and upon acknowledgment, the extension will respond with its name which will be logged onto terminal that OpenSearch is running on.

```
[2022-06-16T21:30:18,857][INFO ][o.o.t.TransportService ] [runTask-0] publish_address {127.0.0.1:9300}, bound_addresses {[::1]:9300}, {127.0.0.1:9300}
Expand Down Expand Up @@ -156,7 +156,7 @@ MESSAGE RECEIVED:ES-ǣ!internal:discovery/extensionsnode_extensionQSt9oKXFTSWqgX
21:30:18.999 [opensearch[extension][transport_worker][T#6]] TRACE org.opensearch.transport.TransportService.tracer - [3][internal:discovery/extensions] sent response
```

It is important that the OpenSearch SDK Java is already up and running on a seperate process prior to starting OpenSearch, since extension discovery occurs only if the OpenSearch SDK Java is already listening on a pre-defined port. Once discovery is complete and the data transfer connection between both nodes has been established, OpenSearch and the OpenSearch SDK Java will now be able to comminicate.
It is important that the OpenSearch SDK for Java is already up and running on a seperate process prior to starting OpenSearch, since extension discovery occurs only if the OpenSearch SDK for Java is already listening on a pre-defined port. Once discovery is complete and the data transfer connection between both nodes has been established, OpenSearch and the OpenSearch SDK for Java will now be able to comminicate.

## Run Tests

Expand Down

0 comments on commit 463cdba

Please sign in to comment.