You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/05/10 15:10:01 UTC
[GitHub] [pulsar] asafm opened a new pull request, #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
asafm opened a new pull request, #15531:
URL: https://github.com/apache/pulsar/pull/15531
<!--
### Contribution Checklist
- PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.trs9rsex3xom)*.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
### Modifications
* Managed Ledger is explained after it is mentioned in Messaging and Concepts documentation hence the needed hyperlink
* Running Pulsar standalone on M1 introduces challenges due to new architecture not yet supported. The docs now explain how to overcome that
*Describe the modifications you've done.*
### Verifying this change
- [ ] Make sure that the change passes the CI checks.
This change is a trivial rework / code cleanup without any test coverage.
### Documentation
Check the box below or label this PR directly.
Need to update docs?
- [ ] `doc-required`
(Your PR needs to update docs and you will update later)
- [ ] `no-need-doc`
(Please explain why)
- [ ] `doc`
(Your PR contains doc changes)
- [ ] `doc-added`
(Docs have been already added)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r869846553
##########
site2/docs/getting-started-standalone.md:
##########
@@ -23,6 +23,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefor it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
Review Comment:
```suggestion
In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefore it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
```
By saying "the current version", you are referring to 2.10 only, right? If yes, I think this update only applies to 2.10 docs under /site2/website/versioned_docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] asafm commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
asafm commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r871349411
##########
site2/docs/getting-started-standalone.md:
##########
@@ -23,6 +23,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
Review Comment:
Ok. I moved the changes to 2.10.0
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] merlimat commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
merlimat commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r870568581
##########
site2/docs/getting-started-standalone.md:
##########
@@ -23,6 +23,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
Review Comment:
Actually, we should make this change in `./site2/website/versioned_docs/version-2.10.0/getting-started-standalone.md` rather than the current "master" doc file.
2.10 is the current default documentation being shown on the website right now
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] github-actions[bot] commented on pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#issuecomment-1122566799
@asafm:Thanks for providing doc info!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] merlimat commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
merlimat commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r869494433
##########
site2/docs/getting-started-standalone.md:
##########
@@ -23,6 +23,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
Review Comment:
We're going to fix this for 2.11 (upgrading RocksDB) so we should take a note to remove this portion of docs once that release is out.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] github-actions[bot] commented on pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#issuecomment-1122566291
@asafm:Thanks for your contribution. For this PR, do we need to update docs?
(The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r871940435
##########
site2/website/versioned_docs/version-2.10.0/getting-started-standalone.md:
##########
@@ -24,6 +24,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefore it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
Review Comment:
```suggestion
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.
```
Split these long sentences to improve readability. Feel free to correct this.
##########
site2/website/versioned_docs/version-2.10.0/getting-started-standalone.md:
##########
@@ -24,6 +24,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefore it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
+
+One of the ways to easily install an x86 JDK is to use [SDKMan](http://sdkman.io) as outlined in the following steps:
+
+1. Install [SDKMan](http://sdkman.io) following instructions on their website, or if you have [Homebrew](https://brew.sh) installed then type:
+```shell
+brew install sdkman
+```
+2. Turn on Rosetta2 compatibility for SDKMan by editing `~/.sdkman/etc/config` and changing the following property from `false` to `true`.
+```properties
+sdkman_rosetta2_compatible=true
+```
+3. Close the current shell / terminal window and open a new one
+4. Make sure you don't have any previously installed JVM of same version by listing existing installed versions:
Review Comment:
```suggestion
4. Make sure you don't have any previously installed JVM of the same version by listing existing installed versions.
```
##########
site2/website/versioned_docs/version-2.10.0/getting-started-standalone.md:
##########
@@ -24,6 +24,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefore it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
+
+One of the ways to easily install an x86 JDK is to use [SDKMan](http://sdkman.io) as outlined in the following steps:
+
+1. Install [SDKMan](http://sdkman.io) following instructions on their website, or if you have [Homebrew](https://brew.sh) installed then type:
+```shell
+brew install sdkman
+```
+2. Turn on Rosetta2 compatibility for SDKMan by editing `~/.sdkman/etc/config` and changing the following property from `false` to `true`.
+```properties
+sdkman_rosetta2_compatible=true
+```
+3. Close the current shell / terminal window and open a new one
Review Comment:
```suggestion
3. Close the current shell / terminal window and open a new one.
```
##########
site2/website/versioned_docs/version-2.10.0/getting-started-standalone.md:
##########
@@ -24,6 +24,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefore it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
+
+One of the ways to easily install an x86 JDK is to use [SDKMan](http://sdkman.io) as outlined in the following steps:
+
+1. Install [SDKMan](http://sdkman.io) following instructions on their website, or if you have [Homebrew](https://brew.sh) installed then type:
+```shell
+brew install sdkman
+```
+2. Turn on Rosetta2 compatibility for SDKMan by editing `~/.sdkman/etc/config` and changing the following property from `false` to `true`.
+```properties
+sdkman_rosetta2_compatible=true
+```
+3. Close the current shell / terminal window and open a new one
+4. Make sure you don't have any previously installed JVM of same version by listing existing installed versions:
+```shell
+sdk list java|grep installed
+```
+
+Example output:
+```text
+ | >>> | 17.0.3.6.1 | amzn | installed | 17.0.3.6.1-amzn
+```
+
+If you have any Java 17 version installed, uninstall it:
Review Comment:
```suggestion
If you have any Java 17 version installed, uninstall it.
```
##########
site2/website/versioned_docs/version-2.10.0/getting-started-standalone.md:
##########
@@ -24,6 +24,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefore it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
+
+One of the ways to easily install an x86 JDK is to use [SDKMan](http://sdkman.io) as outlined in the following steps:
+
+1. Install [SDKMan](http://sdkman.io) following instructions on their website, or if you have [Homebrew](https://brew.sh) installed then type:
+```shell
+brew install sdkman
+```
+2. Turn on Rosetta2 compatibility for SDKMan by editing `~/.sdkman/etc/config` and changing the following property from `false` to `true`.
+```properties
+sdkman_rosetta2_compatible=true
+```
+3. Close the current shell / terminal window and open a new one
+4. Make sure you don't have any previously installed JVM of same version by listing existing installed versions:
+```shell
+sdk list java|grep installed
+```
+
+Example output:
+```text
+ | >>> | 17.0.3.6.1 | amzn | installed | 17.0.3.6.1-amzn
+```
+
+If you have any Java 17 version installed, uninstall it:
+```shell
+sdk uinstall java 17.0.3.6.1
+```
+
+5. Install any java versions greater than 8:
Review Comment:
```suggestion
5. Install any Java versions greater than Java 8.
```
##########
site2/website/versioned_docs/version-2.10.0/getting-started-standalone.md:
##########
@@ -24,6 +24,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
Review Comment:
```suggestion
#### Install JDK on M1
```
Use base verb for easier search
##########
site2/website/versioned_docs/version-2.10.0/getting-started-standalone.md:
##########
@@ -24,6 +24,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefore it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
+
+One of the ways to easily install an x86 JDK is to use [SDKMan](http://sdkman.io) as outlined in the following steps:
+
+1. Install [SDKMan](http://sdkman.io) following instructions on their website, or if you have [Homebrew](https://brew.sh) installed then type:
Review Comment:
```suggestion
1. Install [SDKMan](http://sdkman.io).
* Method 1: follow instructions on the SDKMan website.
* Method 2: if you have [Homebrew](https://brew.sh) installed, enter the following command.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r869849002
##########
site2/docs/getting-started-standalone.md:
##########
@@ -23,6 +23,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefor it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
+
+One of the ways to easily install an x86 JDK is to use [SDKMan](http://sdkman.io) as outlined in the following steps:
+
+1. Install [SDKMan](http://sdkman.io) following instructions on their website, or if you have [Homebrew](https://brew.sh) installed then type:
+```shell
+brew install sdkman
+```
+2. Turn on Rosetta2 compatability for SDKMan by editing `~/.sdkman/etc/config` and changing the following property from `false` to `true`
+```properties
+sdkman_rosetta2_compatible=true
+```
+3. Close the current shell / terminal window and open a new one
+4. Make sure you don't have any previously installed JVM of same version by listing existing installed versions:
+```shell
+sdk list java|grep installed
+```
+
+Example output:
+```text
+ | >>> | 17.0.3.6.1 | amzn | installed | 17.0.3.6.1-amzn
+```
+
+If you have any Java 17 version installed, uninstall it:
+```shell
+sdk uinstall java 17.0.3.6.1
+```
+
+5. Install any java version greater than 8:
Review Comment:
```suggestion
5. Install any Java versions higher than 8:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r869846794
##########
site2/docs/getting-started-standalone.md:
##########
@@ -23,6 +23,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefor it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
+
+One of the ways to easily install an x86 JDK is to use [SDKMan](http://sdkman.io) as outlined in the following steps:
+
+1. Install [SDKMan](http://sdkman.io) following instructions on their website, or if you have [Homebrew](https://brew.sh) installed then type:
+```shell
+brew install sdkman
+```
+2. Turn on Rosetta2 compatability for SDKMan by editing `~/.sdkman/etc/config` and changing the following property from `false` to `true`
Review Comment:
```suggestion
2. Turn on Rosetta2 compatibility for SDKMan by editing `~/.sdkman/etc/config` and changing the following property from `false` to `true`.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] merlimat merged pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
merlimat merged PR #15531:
URL: https://github.com/apache/pulsar/pull/15531
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] asafm commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
asafm commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r870239766
##########
site2/docs/getting-started-standalone.md:
##########
@@ -23,6 +23,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefor it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
Review Comment:
@momo-jun No, I mean any version, starting with current one until it is fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] asafm commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
asafm commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r870238475
##########
site2/docs/getting-started-standalone.md:
##########
@@ -23,6 +23,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
Review Comment:
Where shall I place this note @merlimat ? An issue?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on a diff in pull request #15531: [improve][doc] Clarify documentation regarding M1 JDK and Managed Ledger
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #15531:
URL: https://github.com/apache/pulsar/pull/15531#discussion_r870247811
##########
site2/docs/getting-started-standalone.md:
##########
@@ -23,6 +23,40 @@ Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**.
> **Note**
> Broker is only supported on 64-bit JVM.
+#### Installing JDK on M1
+In current version, Pulsar uses a BookKeeper version which in turn uses RocksDB which was compiled to work on x86 architecture and not ARM therefor it can only work with x86 JDK. This is planned to be fixed in future versions of Pulsar.
Review Comment:
I got your point. I thought RocksDB metadata service was introduced in 2.10 :)
If this change applies to more historical versions of docs, such as 2.10, 2.9 and etc, you can still update them under /site2/website/versioned_docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org