Rename this project to opensearch-extensions or opensearch-extensions-java

[peternied]

This project is named opensearch-sdk and that name is pretty broad, while this is an OpenSearch specific repository, it seems to be focused on an extensibility sdk based on the content in the readme.

In the future there might be rust/go/node/... extensions software development kits to help make extensions more easily which would be named opensearch-extensions-rs

What do you guys think?

[dbwiddis]

The extension points should be language agnostic. It shouldn't matter what language an extension is written in, if it follows the appropriate API. I think naming it "extensions" actually gives the impression that the extensions themselves would be developed in this project.

I agree sdk is a bit too vague, though. What about opensearch-extension-sdk or opensearch-plugin-sdk?

[peternied]

I like opensearch-plugin-sdk +1 for that name.

[peternied]

The extension points should be language agnostic.

While the extensions interface is via Rest API, there could be SDKs available in many different language implementations, such as how there are many OpenSearch client implementations in other programming languages.

[owaiskazi19]

I am fine with opensearch-extension-sdk as it briefly describes sdk for extensibility. In the future, we will be supporting SDK with other languages, for which we can name them as opensearch-extension-sdk-rs, opensearch-extension-sdk-js etc. It'll be great to hear from @dblock and @saratvemulapalli on the same.

[dblock]

This is a very valid point. I think I'd like openearch-sdk-java the best. We're not going to have a million SDKs, and this is Java-specific?

[peternied]

This issue has been a little stagnate, do one of the maintainers want to drive this rename or call it off?

[saratvemulapalli]

I am not really torn as long its named sdk.
I see we have a bunch of options:

• opensearch-extensions
• opensearch-extensions-java
• openearch-sdk-java
• opensearch-extension-sdk

If i have to choose I'll go with opensearch-sdk-java.
Folks put in your vote and lets take a call in 2 weeks. (Aug 12)
@peternied @dbwiddis @owaiskazi19

[owaiskazi19]

If i have to choose I'll go with opensearch-sdk-java. Folks put in your vote and lets take a call in 2 weeks. (Aug 12) @peternied @dbwiddis @owaiskazi19

opensearch-sdk-java

[peternied]

opensearch-sdk-java +1

[dbwiddis]

opensearch-sdk-java +2

[dblock]

Sold!

[saratvemulapalli]

Looks like we are sold!!
@vibrantvarun can you pick this up and rename everything to opensearch-sdk-java?

[owaiskazi19]

@mloufra will pick this up

[owaiskazi19]

Done!

[saratvemulapalli]

@mloufra @owaiskazi19 do we have to rename anything in the code?
I can see the gradle project[1] has to be. Probably there are others?

[1] https://github.com/opensearch-project/opensearch-sdk-java/blob/main/settings.gradle#L1

[dbwiddis]

Probably there are others?

opensearch-sdk-java/DEVELOPER_GUIDE.md

Line 22 in 0727269

Fork [OpenSearch SDK](https://github.com/opensearch-project/opensearch-sdk) and clone locally, e.g. `git clone https://github.com/[your username]/opensearch-sdk.git`.

This one I'm changing as part of my PR #74. It must match the name in the extension.yml file until #93 is complete.

opensearch-sdk-java/DEVELOPER_GUIDE.md

Line 76 in 0727269

- name: opensearch-sdk

opensearch-sdk-java/DEVELOPER_GUIDE.md

Lines 168 to 190 in 0727269

	In opensearch-sdk navigate to build/distributions. Look for tar ball in the form `opensearch-sdk-1.0.0-SNAPSHOT.tar`. If not found follow the below steps to create one:
	```
	./gradlew clean && ./gradlew build
	```
	Once the tar ball is generated navigate to /src/test/resources and look for extension.yml. Create one if not present
	Look for tar ball in /build/distributions. To run the artifact i.e. tar ball, run the below command
	```
	tar -xvf opensearch-sdk-1.0.0-SNAPSHOT.tar
	```
	TODO https://github.com/opensearch-project/opensearch-sdk/issues/52
	Navigate to opensearch-sdk/build/distributions/opensearch-sdk-1.0.0-SNAPSHOT/
	- Check if src folder exists in using `ls`.
	- If the src folder does not exist, create it using `mkdir src && cd src && mkdir test && cd test && mkdir resources && cd resources`.
	The above command will generate a path opensearch-sdk/build/distributions/opensearch-sdk-1.0.0-SNAPSHOT/src/test/resources
	- Manually create a file titled `extension.yml` within the resources directory using an IDE or an in-line text editor. Below is the sample of extension.yml
	Sample extensions.yml file:
	```
	extensionName: extension
	hostAddress: 127.0.0.1
	hostPort: 4532
	```
	- After extension.yml is generated then start opensearch-sdk by ./bin/opensearch-sdk

[owaiskazi19]

@mloufra @owaiskazi19 do we have to rename anything in the code? I can see the gradle project[1] has to be. Probably there are others?

[1] https://github.com/opensearch-project/opensearch-sdk-java/blob/main/settings.gradle#L1

That's a miss. Thanks @saratvemulapalli and @dbwiddis for bringing this up. @mloufra will look into it.