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.

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

Conversation

gaobinlong
Copy link
Contributor

@gaobinlong gaobinlong commented Nov 9, 2023

Description

When running OpenSearch with knn plugin on MAC M1, we need to build the JNI library such as faiss, nmslib manually, but if we don't use JDK for ARM, then we can see the error mach-o file, but is an incompatible architecture (have 'arm64', need 'x86_64') when executing knn search. And if we start OpenSearch by running ./bin/opensearch directly on MAC M1 and do not set the environment variable JAVA_LIBRARY_PATH, then OpenSearch cannot find the JNI library. We need to add more description about how to run OpenSearchon MAC M1 to make it clear for users.

Issues Resolved

#580

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed as per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…guide

Signed-off-by: gaobinlong <gbinlong@amazon.com>
Copy link

codecov bot commented Nov 9, 2023

Codecov Report

Merging #1302 (672feb8) into main (87ddcb6) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main    #1302   +/-   ##
=========================================
  Coverage     85.13%   85.13%           
  Complexity     1210     1210           
=========================================
  Files           160      160           
  Lines          4931     4931           
  Branches        449      449           
=========================================
  Hits           4198     4198           
  Misses          537      537           
  Partials        196      196           

jmazanec15
jmazanec15 previously approved these changes Nov 9, 2023
Copy link
Member

@jmazanec15 jmazanec15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! LGTM

Copy link
Member

@ryanbogan ryanbogan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great addition to the developer guide! Few suggestions on the wording to make the steps the user has to take a little more clear.

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
@ryanbogan
Copy link
Member

LGTM! Thanks for the contribution!

@ryanbogan ryanbogan merged commit aef2d26 into opensearch-project:main Nov 17, 2023
46 of 51 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 17, 2023
…guide (#1302)

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

Signed-off-by: gaobinlong <gbinlong@amazon.com>

* Change some wording

Signed-off-by: gaobinlong <gbinlong@amazon.com>

---------

Signed-off-by: gaobinlong <gbinlong@amazon.com>
(cherry picked from commit aef2d26)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants