Skip to content

Commit

Permalink
Update Developer Guide
Browse files Browse the repository at this point in the history
Signed-off-by: Varun Jain <varunudr@amazon.com>
  • Loading branch information
vibrantvarun committed Aug 12, 2022
1 parent 27d7848 commit 8dfbb18
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,21 @@ Look for tar ball in /build/distributions. To run the artifact i.e. tar ball, ru
```
tar -xvf opensearch-sdk-1.0.0-SNAPSHOT.tar
```
For now, create the extension.yml file within opensearch-sdk/build/distributions/opensearch-sdk-1.0.0-SNAPSHOT/src/test/resources/ and then run ./bin/opensearch-sdk to start opensearch
For now, 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

## Submitting Changes

See [CONTRIBUTING](CONTRIBUTING.md).

0 comments on commit 8dfbb18

Please sign in to comment.