[fix][doc] Fix M1 JVM Installation Instructions #17669
Conversation
README.md
Outdated
| @@ -138,6 +138,47 @@ Requirements: | |||
| > Note: this project includes a [Maven Wrapper](https://maven.apache.org/wrapper/) that can be used instead of a system installed Maven. | |||
| > Use it by replacing `mvn` by `./mvnw` on Linux and `mvnw.cmd` on Windows in the commands below. | |||
|
|
|||
| ### Install JDK on M1 | |||
There was a problem hiding this comment.
I wrote:
"how to install JDK on M1" is not suitable to document on the Get Started page. Imagine that you don't tell users how to buy a computer. It's far away from Pulsar topics. Users can resolve it with Google, StackOverflow, etc.
in #17409 (comment). This stands for README.md also. I can imagine users have multiple approaches to do this and we don't have to use forty lines for it. If someone asked, we resolve the discussion or issue. And followers should be able to search or we simply answer by throwing the link.
There was a problem hiding this comment.
For example, I install JDK on M1 simply with sdk install java without all the troubleshooting here and it works well.
There was a problem hiding this comment.
This issue happened to me and 5 other engineers I know of just as an example.
Our approach, especially on getting started should be giving you everything you need to get started - in the README case, it's building the product. M1 is notorious to have many quirks. Anything we can do to help will be greatly appreciated.
Just mentioning a few people recently running into those issues @geomagilles @teabot @nahguam just to name a few
Bear in mind, that they can ignore this recommendation. Most newcomers will appreciate it as much as I did.
github-actions
bot
added
the
doc
README.md
Outdated
| @@ -138,6 +138,47 @@ Requirements: | |||
| > Note: this project includes a [Maven Wrapper](https://maven.apache.org/wrapper/) that can be used instead of a system installed Maven. | |||
| > Use it by replacing `mvn` by `./mvnw` on Linux and `mvnw.cmd` on Windows in the commands below. | |||
|
|
|||
| ### Install JDK on M1 | |||
| In the current version, Pulsar uses a BookKeeper version which in turn uses RocksDB. RocksDB is compiled to work on x86 architecture and not ARM. Therefore, Pulsar can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar. | |||
There was a problem hiding this comment.
This doesn't stand any more on the nightly version. See also #12166 (comment).
I agree that there can be a few troubleshooting to work on a different environment with older version, and I'd prefer a discussion thread (#12166 seems a good place to comment these instructions and closed).
There was a problem hiding this comment.
And I just notice that it misleads me because it's not about "Install JDK on M1" - it's about "Install X86 JDK on M1" (if you get a RocksDB JNI load exception).
https://www.google.com/search?q=Install+x86+JDK+on+M1 gives you:
- https://itnext.io/how-to-install-x86-and-arm-jdks-on-the-mac-m1-apple-silicon-using-sdkman-872a5adc050d
- Question: Install x86 JDK on M1 Mac sdkman/sdkman-cli#1068
That can help.
There was a problem hiding this comment.
So the meaningful information here is, that if you fail to run Pulsar on M1 due to RocksDB JNI error (with a typical stack trace), the reason is that you need an X86 JDK for older versions. Then mention some methods to achieve it as you like.
I get confused the first time: I'm an M1 user, and this section seems written for me. But it's not. It's for those who running Pulsar <= 2.10 on M1 and get the RocksDB JNI load exception.
There was a problem hiding this comment.
And perhaps after we release 2.11.0 and users start to use the new version, it will be less and less useful.
M1 is notorious to have many quirks. Anything we can do to help will be greatly appreciated.
I agree. So +0 on this patch now. FYI - I encounter several other issues, and I prefer to resolve troubleshootings in discussions instead of a manual try to cover most of them:
There was a problem hiding this comment.
Ok. I agree. It's mostly targeted at users trying to develop Pulsar and since it was solved on master, it's not beneficial anymore.
|
@tisonkun I reduced the PR by just fixing 2.10 instructions then |
|
@tisonkun How do we continue from here? |
|
Let me try to find a committer to help with reviewing and merging. I don't have write permission here :) |
Modifications
Fix the documentation of installing JVM on M1 - remove one installation method of sdkman (using brew) and add the deleted instructions to building Pulsar on README
Documentation
doc-required(Your PR needs to update docs and you will update later)
doc-not-needed(Please explain why)
doc(Your PR contains doc changes)
doc-complete(Docs have been already added)