Skip to content

Commit

Permalink
Remove broken link from DEVELOPER_GUIDE.md (opensearch-project#2582)
Browse files Browse the repository at this point in the history
* Update DEVELOPER_GUIDE.md

Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>

* Update DEVELOPER_GUIDE.md

Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>

* Update DEVELOPER_GUIDE.md

Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>

* Update DEVELOPER_GUIDE.md

Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>

---------

Signed-off-by: Saadat Nursultan <nursultan.saadat@gmail.com>
Signed-off-by: Maciej Mierzwa <dev.maciej.mierzwa@gmail.com>
  • Loading branch information
nurSaadat authored and MaciejMierzwa committed Apr 27, 2023
1 parent 9967bb0 commit e64e969
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,16 @@ cd $OPENSEARCH_HOME

The `curl localhost:9200` call should succeed again. Kill the server with `Ctrl+c`. We are now ready to install the security plugin.


>Worth noting:\
> The version of OpenSearch and the security plugin must match as there is an explicit version check at startup. This can be a bit confusing as, for example, at the time of writing this guide, the `main` branch of this security plugin builds version `1.3.0.0-SNAPSHOT` compatible with OpenSearch `1.3.0-SNAPSHOT` that gets built from branch `1.x`. Check the expected compatible version [here](https://github.com/opensearch-project/security/blob/main/plugin-descriptor.properties#L27) and make sure you get the correct branch from OpenSearch when building that project.
> The version of OpenSearch and the security plugin must match as there is an explicit version check at startup. This can be a bit confusing as, for example, at the time of writing this guide, the `main` branch of this security plugin builds version `3.0.0.0-SNAPSHOT` compatible with OpenSearch `3.0.0`. Check the expected compatible version in `build.gradle` file [here](https://github.com/opensearch-project/security/blob/main/build.gradle) and make sure you get the correct branch from OpenSearch when building that project.
>
> The line to look for: `opensearch_version = System.getProperty("opensearch.version", "x")`
>
> Alternatively, you can find the compatible version of OpenSearch by running in project root folder
> ```
> ./gradlew properties -q | grep -E '^version:' | awk '{print $2}'
> ```
## Building

Expand Down

0 comments on commit e64e969

Please sign in to comment.