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

Add more description about running OpenSearch on MAC M1 to developer guide #1302

Merged
merged 3 commits into from
Nov 17, 2023
Merged

Add more description about running OpenSearch on MAC M1 to developer guide #1302

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1e4d90
Add more description about running OpenSearch on MAC M1 to developer …
gaobinlong Nov 9, 2023
e92d68b
Merge remote-tracking branch 'upstream/main'
gaobinlong Nov 13, 2023
672feb8
Change some wording
gaobinlong Nov 13, 2023
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
7 changes: 7 additions & 0 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,13 @@ Next, obtain a minimum distribution tarball of the k-NN version you want to buil
4. You should see a opensearch-min-<version>-SNAPSHOT-darwin-x64.tar.gz file present in distribution/archives/darwin-tar/build/distributions/
5. Build k-NN by passing the OpenSearch distribution path in `./gradlew <integTest/run> -PcustomDistributionUrl="<Full path to .tar.gz file you noted above>"`

If you want to start OpenSearch directly on Mac M1, make sure to use JDK for ARM. Otherwise, you will see the following error: `mach-o file, but is an incompatible architecture (have 'arm64', need 'x86_64')`. It is better to start OpenSearch by running `bash opensearch-tar-install.sh` instead of `./bin/opensearch`. To run `./bin/opensearch`, the environment variable `JAVA_LIBRARY_PATH` needs to be set correctly so that OpenSearch can find the JNI library:

```
export OPENSEARCH_HOME=the directory of opensearch...
export JAVA_LIBRARY_PATH=$JAVA_LIBRARY_PATH:$OPENSEARCH_HOME/plugins/opensearch-knn/lib
```

#### Environment

Currently, the plugin only supports Linux on x64 and arm platforms.
Expand Down
Loading