Add more description about running OpenSearch on MAC M1 to developer …

…guide (#1302) * Add more description about running OpenSearch on MAC M1 to developer guide Signed-off-by: gaobinlong <[email protected]> * Change some wording Signed-off-by: gaobinlong <[email protected]> --------- Signed-off-by: gaobinlong <[email protected]> (cherry picked from commit aef2d26)
opensearch-project · Nov 17, 2023 · 4fb972c · 4fb972c
1 parent ddf988d
commit 4fb972c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -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.