Anonymitaet commented on code in PR #17475: URL: https://github.com/apache/pulsar/pull/17475#discussion_r963330176
########## site2/docs/getting-started-standalone.md: ########## @@ -1,278 +1,139 @@ --- id: getting-started-standalone -title: Set up a standalone Pulsar locally +title: Run a standalone Pulsar cluster locally sidebar_label: "Run Pulsar locally" --- -For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary [RocksDB](http://rocksdb.org/) and BookKeeper components running inside of a single Java Virtual Machine (JVM) process. - -> **Pulsar in production?** -> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide. - -## Install Pulsar standalone - -This tutorial guides you through every step of installing Pulsar locally. - -### System requirements - -Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK. -For the runtime Java version, see [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version. +For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode runs all components inside a single Java Virtual Machine (JVM) process. :::tip -By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is an extra option passed into JVM. +If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide. ::: -:::note +## Prerequisites -Broker is only supported on 64-bit JVM. +- JRE (64-bit). Different Pulsar versions rely on different JRE versions. For how to choose the JRE version, see [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation). -::: - -#### 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. - -One of the ways to easily install an x86 JDK is to use [SDKMan](http://sdkman.io). Follow instructions on the SDKMan website. - -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 -``` +## Step 1. Download Pulsar distribution -3. Close the current shell / terminal window and open a new one. -4. Make sure you don't have any previously installed JVM of the same version by listing existing installed versions. +Download the official Apache Pulsar distribution: -```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 +```bash +wget https://archive.apache.org/dist/pulsar/pulsar-@pulsar:version@/apache-pulsar-@pulsar:[email protected] ``` -5. Install any Java versions greater than Java 8. +Once downloaded, unpack the tar file: -```shell - sdk install java 17.0.3.6.1-amzn +```bash +tar xvfz apache-pulsar-@pulsar:[email protected] ``` -### Install Pulsar using binary release - -To get started with Pulsar, download a binary tarball release in one of the following ways: - -* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>) - -* download from the Pulsar [downloads page](pulsar:download_page_url) - -* download from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest) - -* use [wget](https://www.gnu.org/software/wget): - - ```shell - wget pulsar:binary_release_url - ``` - -After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory: +For the rest of this quickstart we'll run commands from the root of the distribution folder, so switch to it: Review Comment: Can you check all occurrences of "we"? (I only comment on one place) ########## site2/docs/getting-started-standalone.md: ########## @@ -1,278 +1,139 @@ --- id: getting-started-standalone -title: Set up a standalone Pulsar locally +title: Run a standalone Pulsar cluster locally sidebar_label: "Run Pulsar locally" --- -For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode includes a Pulsar broker, the necessary [RocksDB](http://rocksdb.org/) and BookKeeper components running inside of a single Java Virtual Machine (JVM) process. - -> **Pulsar in production?** -> If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide. - -## Install Pulsar standalone - -This tutorial guides you through every step of installing Pulsar locally. - -### System requirements - -Currently, Pulsar is available for 64-bit **macOS**, **Linux**, and **Windows**. To use Pulsar, you need to install 64-bit JRE/JDK. -For the runtime Java version, see [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version. +For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode runs all components inside a single Java Virtual Machine (JVM) process. :::tip -By default, Pulsar allocates 2G JVM heap memory to start. It can be changed in `conf/pulsar_env.sh` file under `PULSAR_MEM`. This is an extra option passed into JVM. +If you're looking to run a full production Pulsar installation, see the [Deploying a Pulsar instance](deploy-bare-metal.md) guide. ::: -:::note +## Prerequisites -Broker is only supported on 64-bit JVM. +- JRE (64-bit). Different Pulsar versions rely on different JRE versions. For how to choose the JRE version, see [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation). -::: - -#### 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. - -One of the ways to easily install an x86 JDK is to use [SDKMan](http://sdkman.io). Follow instructions on the SDKMan website. - -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 -``` +## Step 1. Download Pulsar distribution -3. Close the current shell / terminal window and open a new one. -4. Make sure you don't have any previously installed JVM of the same version by listing existing installed versions. +Download the official Apache Pulsar distribution: -```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 +```bash +wget https://archive.apache.org/dist/pulsar/pulsar-@pulsar:version@/apache-pulsar-@pulsar:[email protected] ``` -5. Install any Java versions greater than Java 8. +Once downloaded, unpack the tar file: -```shell - sdk install java 17.0.3.6.1-amzn +```bash +tar xvfz apache-pulsar-@pulsar:[email protected] ``` -### Install Pulsar using binary release - -To get started with Pulsar, download a binary tarball release in one of the following ways: - -* download from the Apache mirror (<a href="pulsar:binary_release_url" download>Pulsar @pulsar:version@ binary release</a>) - -* download from the Pulsar [downloads page](pulsar:download_page_url) - -* download from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest) - -* use [wget](https://www.gnu.org/software/wget): - - ```shell - wget pulsar:binary_release_url - ``` - -After you download the tarball, untar it and use the `cd` command to navigate to the resulting directory: +For the rest of this quickstart we'll run commands from the root of the distribution folder, so switch to it: ```bash -tar xvfz apache-pulsar-@pulsar:[email protected] cd apache-pulsar-@pulsar:version@ ``` -#### What your package contains - -The Pulsar binary package initially contains the following directories: - -Directory | Contains -:---------|:-------- -`bin` | Pulsar's command-line tools, such as [`pulsar`](reference-cli-tools.md#pulsar) and [`pulsar-admin`](/tools/pulsar-admin/). -`conf` | Configuration files for Pulsar, including [broker configuration](reference-configuration.md#broker) and more.<br />**Note:** Pulsar standalone uses RocksDB as the local metadata store and its configuration file path [`metadataStoreConfigPath`](reference-configuration.md) is configurable in the `standalone.conf` file. For more information about the configurations of RocksDB, see [here](https://github.com/facebook/rocksdb/blob/main/examples/rocksdb_option_file_example.ini) and related [documentation](https://github.com/facebook/rocksdb/wiki/RocksDB-Tuning-Guide). -`examples` | A Java JAR file containing [Pulsar Functions](functions-overview.md) example. -`instances` | Artifacts created for [Pulsar Functions](functions-overview.md). -`lib` | The [JAR](https://en.wikipedia.org/wiki/JAR_(file_format)) files used by Pulsar. -`licenses` | License files, in the`.txt` form, for various components of the Pulsar [codebase](https://github.com/apache/pulsar). - -These directories are created once you begin running Pulsar. - -Directory | Contains -:---------|:-------- -`data` | The data storage directory used by RocksDB and BookKeeper. -`logs` | Logs created by the installation. +List the contents by executing: -:::tip - -If you want to use built-in connectors and tiered storage offloaders, you can install them according to the following instructions： -* [Install built-in connectors (optional)](#install-built-in-connectors-optional) -* [Install tiered storage offloaders (optional)](#install-tiered-storage-offloaders-optional) -Otherwise, skip this step and perform the next step [Start Pulsar standalone](#start-pulsar-standalone). Pulsar can be successfully installed without installing built-in connectors and tiered storage offloaders. - -::: - -### Install built-in connectors (optional) - -Since `2.1.0-incubating` release, Pulsar releases a separate binary distribution, containing all the `built-in` connectors. -To enable those `built-in` connectors, you can download the connectors tarball release in one of the following ways: - -* download from the Apache mirror <a href="pulsar:connector_release_url" download>Pulsar IO Connectors @pulsar:version@ release</a> - -* download from the Pulsar [downloads page](pulsar:download_page_url) +```bash +ls -1F +``` -* download from the Pulsar [releases page](https://github.com/apache/pulsar/releases/latest) +You may want to note that: -* use [wget](https://www.gnu.org/software/wget): +| Directory | Contains | Review Comment: ```suggestion | Directory | Description | ``` Use nouns in parallel -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
