Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the developer guide with new Java requirements #787

Merged
merged 1 commit into from
Apr 3, 2025
Merged

Updated the developer guide with new Java requirements #787

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,16 @@ This document will walk you through on what's needed to start contributing code
brew install pyenv jq zlib xz
```

- **JDK**: Although OSB is a Python application, it optionally builds and provisions OpenSearch clusters. JDK version 17 is used to build the current version of OpenSearch. Please refer to the [build setup requirements](https://github.com/opensearch-project/OpenSearch/blob/ca564fd04f5059cf9e3ce8aba442575afb3d99f1/DEVELOPER_GUIDE.md#install-prerequisites).
Note that the `javadoc` executable should be available in the JDK installation. An earlier version of the JDK can be used, but not all the integration tests will pass.
- **JDK**: Although OSB is a Python application, it optionally builds and provisions OpenSearch clusters. JDK version 21 is required to build the current version of OpenSearch. Please refer to the [build setup requirements](https://github.com/opensearch-project/OpenSearch/blob/ca564fd04f5059cf9e3ce8aba442575afb3d99f1/DEVELOPER_GUIDE.md#install-prerequisites).
Note that the `javadoc` executable should be available in the JDK installation.

If OSB is asked to run with an earlier version of OpenSearch, an older version of the JDK such as version 17 will be required. Version 21 has eliminated support for the Security Manager which is used by these OpenSearch releases.

The integration tests exercise both older versions of OpenSearch and the latest version as part of the test suite. Therefore, two versions of the JDK will need to be installed and the appropriate environment variables set, like so:

```
export JAVA_HOME=/path/to/JDK17
export JAVA21_HOME=/path/to/JDK21
export JAVA17_HOME=/path/to/JDK17

```

Expand Down
Loading