This is an automated email from the ASF dual-hosted git repository.
lhotari pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 285e601162f Update #1033 changes to versioned_docs
285e601162f is described below
commit 285e601162fa9f134c23e80db740bd3592bd0dfe
Author: Lari Hotari <lhot...@users.noreply.github.com>
AuthorDate: Tue Sep 9 09:52:06 2025 +0300
Update #1033 changes to versioned_docs
---
.../version-3.0.x/getting-started-docker.md | 12 ++++++++----
versioned_docs/version-3.0.x/getting-started-helm.md | 19 +++++++++++++------
.../version-3.0.x/getting-started-standalone.md | 8 +++++++-
versioned_docs/version-3.0.x/standalone-docker.md | 6 +++++-
.../version-4.0.x/getting-started-docker-compose.md | 13 ++++++++++---
.../version-4.0.x/getting-started-docker.md | 12 ++++++++----
versioned_docs/version-4.0.x/getting-started-helm.md | 19 +++++++++++++------
.../version-4.0.x/getting-started-standalone.md | 8 +++++++-
versioned_docs/version-4.0.x/standalone-docker.md | 6 +++++-
.../version-4.1.x/getting-started-docker-compose.md | 13 ++++++++++---
.../version-4.1.x/getting-started-docker.md | 12 ++++++++----
versioned_docs/version-4.1.x/getting-started-helm.md | 19 +++++++++++++------
.../version-4.1.x/getting-started-standalone.md | 8 +++++++-
versioned_docs/version-4.1.x/standalone-docker.md | 6 +++++-
14 files changed, 119 insertions(+), 42 deletions(-)
diff --git a/versioned_docs/version-3.0.x/getting-started-docker.md
b/versioned_docs/version-3.0.x/getting-started-docker.md
index 361746f0898..bddd5d2f545 100644
--- a/versioned_docs/version-3.0.x/getting-started-docker.md
+++ b/versioned_docs/version-3.0.x/getting-started-docker.md
@@ -6,7 +6,11 @@ sidebar_label: "Run Pulsar in Docker"
For local development and testing, you can run Pulsar in standalone mode on
your own machine within a Docker container.
-If you have not installed Docker, download it following [the
instructions](https://docs.docker.com/get-docker/) for your OS.
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) (version 20.10+ recommended)
+- At least 4GB of available RAM
+- At least 5GB of free disk space
## Start Pulsar in Docker
@@ -18,9 +22,9 @@ docker run -it -p 6650:6650 -p 8080:8080 --mount
source=pulsardata,target=/pulsa
:::tip
-You may encounter issues with the default RocksDB metadata store.
+By default, Pulsar uses RocksDB as the metadata store, which is recommended
for standalone instances.
-We recommend you consider using the following environment variable to use
ZooKeeper as the metadata store:
+If you encounter issues with RocksDB or need compatibility with existing
ZooKeeper-based installations, you can use ZooKeeper as the metadata store by
adding:
```
...
@@ -28,7 +32,7 @@ We recommend you consider using the following environment
variable to use ZooKee
...
```
-Don't apply this fix for existing Pulsar standalone instances if you don't
want to loose your data.
+Note: Switching metadata stores will create a new cluster. Don't apply this to
existing instances unless you want to start fresh.
:::
diff --git a/versioned_docs/version-3.0.x/getting-started-helm.md
b/versioned_docs/version-3.0.x/getting-started-helm.md
index 85bad377f43..5c1c04a4a59 100644
--- a/versioned_docs/version-3.0.x/getting-started-helm.md
+++ b/versioned_docs/version-3.0.x/getting-started-helm.md
@@ -14,11 +14,19 @@ This section guides you through every step of installing
and running Apache Puls
For deploying a Pulsar cluster for production usage, read the documentation on
[how to configure and install a Pulsar Helm chart](helm-deploy.md).
-## Prerequisite
+:::warning Security Notice
-- Kubernetes server 1.21.0+
-- kubectl 1.21.0+
-- Helm 3.10+
+This quickstart guide uses default configurations suitable for development and
testing only. The default Helm chart configuration **does not meet production
security requirements**. For production deployments, you must review and
customize security settings including authentication, authorization, TLS
encryption, and network policies.
+
+:::
+
+## Prerequisites
+
+- Kubernetes server 1.25.0+ ([latest stable
version](https://kubernetes.io/releases/patch-releases/#detailed-release-history-for-active-branches)
recommended)
+- kubectl version that is compatible with your k8s server version ([+/- 1
minor release
version](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#before-you-begin))
+- Helm 3.12+ (choose a [helm version that is compatible with your k8s server
version](https://helm.sh/docs/topics/version_skew/#supported-version-skew))
+- At least 8GB of available RAM in your Kubernetes cluster
+- At least 20GB of persistent storage available
:::tip
@@ -35,10 +43,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/)
in this quick start
1. Create a Kubernetes cluster on Minikube.
```bash
- minikube start --memory=8192 --cpus=4 --kubernetes-version=<k8s-version>
+ minikube start --memory=8192 --cpus=4
```
- The `<k8s-version>` can be any [Kubernetes version supported by your
Minikube
installation](https://minikube.sigs.k8s.io/docs/reference/configuration/kubernetes/),
such as `v1.16.1`.
2. Set `kubectl` to use Minikube.
diff --git a/versioned_docs/version-3.0.x/getting-started-standalone.md
b/versioned_docs/version-3.0.x/getting-started-standalone.md
index e8581c22dbd..f0e922f2111 100644
--- a/versioned_docs/version-3.0.x/getting-started-standalone.md
+++ b/versioned_docs/version-3.0.x/getting-started-standalone.md
@@ -16,7 +16,13 @@ If you're looking to run a full production Pulsar
installation, see the [Deployi
Currently, Pulsar is available for 64-bit **macOS** and **Linux**. See [Run
Pulsar In Docker](getting-started-docker.md) if you want to run Pulsar on
**Windows**.
-Also, you need the proper 64-bit JRE/JDK version installed. Please refer to
[Pulsar Runtime Java Version
Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation).
+Also, you need the proper 64-bit JRE/JDK version installed:
+
+- **Java 17** is required for Pulsar 2.11+ and master branch
+- **Java 11** is required for Pulsar 2.8/2.9/2.10
+- **Java 8** is required for Pulsar 2.7 and earlier
+
+For the latest Java version recommendations, see [Pulsar Runtime Java Version
Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation).
## Download Pulsar distribution
diff --git a/versioned_docs/version-3.0.x/standalone-docker.md
b/versioned_docs/version-3.0.x/standalone-docker.md
index 32f303b799f..524f6dce4cf 100644
--- a/versioned_docs/version-3.0.x/standalone-docker.md
+++ b/versioned_docs/version-3.0.x/standalone-docker.md
@@ -6,7 +6,11 @@ sidebar_label: "Run Pulsar in Docker"
For local development and testing, you can run Pulsar in standalone mode on
your own machine within a Docker container.
-If you have not installed Docker, download it following [the
instructions](https://docs.docker.com/get-docker/) for your OS.
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) (version 20.10+ recommended)
+- At least 4GB of available RAM
+- At least 5GB of free disk space
## Start Pulsar in Docker
diff --git a/versioned_docs/version-4.0.x/getting-started-docker-compose.md
b/versioned_docs/version-4.0.x/getting-started-docker-compose.md
index 10f8d350324..eeceaecd586 100644
--- a/versioned_docs/version-4.0.x/getting-started-docker-compose.md
+++ b/versioned_docs/version-4.0.x/getting-started-docker-compose.md
@@ -7,6 +7,13 @@ description: Get started with Apache Pulsar on your local
machine using Docker C
To run Pulsar locally with Docker Compose, follow the steps below.
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) (version 20.10+ recommended)
+- [Docker Compose](https://docs.docker.com/compose/install/) (version 2.0+
recommended)
+- At least 8GB of available RAM for the cluster
+- At least 10GB of free disk space
+
## Step 1: Configure the `compose.yml` template
To get up and run a Pulsar cluster quickly, you can use the following template
to create a `compose.yml` file by modifying or adding the configurations in the
**environment** section.
@@ -31,11 +38,11 @@ services:
- PULSAR_MEM=-Xms256m -Xmx256m -XX:MaxDirectMemorySize=256m
command:
- bash
- - -c
+ - -c
- |
bin/apply-config-from-env.py conf/zookeeper.conf && \
bin/generate-zookeeper-config.sh conf/zookeeper.conf && \
- exec bin/pulsar zookeeper
+ exec bin/pulsar zookeeper
healthcheck:
test: ["CMD", "bin/pulsar-zookeeper-ruok.sh"]
interval: 10s
@@ -51,7 +58,7 @@ services:
- pulsar
command:
- bash
- - -c
+ - -c
- |
bin/pulsar initialize-cluster-metadata \
--cluster cluster-a \
diff --git a/versioned_docs/version-4.0.x/getting-started-docker.md
b/versioned_docs/version-4.0.x/getting-started-docker.md
index 302ebbf007e..a0f8daac01b 100644
--- a/versioned_docs/version-4.0.x/getting-started-docker.md
+++ b/versioned_docs/version-4.0.x/getting-started-docker.md
@@ -12,7 +12,11 @@ import TabItem from '@theme/TabItem';
For local development and testing, you can run Pulsar in standalone mode on
your own machine within a Docker container.
-If you have not installed Docker, download it following [the
instructions](https://docs.docker.com/get-docker/) for your OS.
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) (version 20.10+ recommended)
+- At least 4GB of available RAM
+- At least 5GB of free disk space
To run Pulsar in Docker, follow the steps below.
@@ -58,9 +62,9 @@ bin/pulsar standalone
:::tip
-You may encounter issues with the default RocksDB metadata store.
+By default, Pulsar uses RocksDB as the metadata store, which is recommended
for standalone instances.
-We recommend you consider using the following environment variable to use
ZooKeeper as the metadata store:
+If you encounter issues with RocksDB or need compatibility with existing
ZooKeeper-based installations, you can use ZooKeeper as the metadata store by
adding:
```
...
@@ -68,7 +72,7 @@ We recommend you consider using the following environment
variable to use ZooKee
...
```
-Don't apply this fix for existing Pulsar standalone instances if you don't
want to loose your data.
+Note: Switching metadata stores will create a new cluster. Don't apply this to
existing instances unless you want to start fresh.
:::
diff --git a/versioned_docs/version-4.0.x/getting-started-helm.md
b/versioned_docs/version-4.0.x/getting-started-helm.md
index 589f7b81e1c..e9715e0a3f5 100644
--- a/versioned_docs/version-4.0.x/getting-started-helm.md
+++ b/versioned_docs/version-4.0.x/getting-started-helm.md
@@ -9,11 +9,19 @@ This section guides you through every step of installing and
running Apache Puls
For deploying a Pulsar cluster for production usage, read the documentation on
[how to configure and install a Pulsar Helm chart](helm-deploy.md).
-## Prerequisite
+:::warning Security Notice
-- Kubernetes server 1.21.0+
-- kubectl 1.21.0+
-- Helm 3.10+
+This quickstart guide uses default configurations suitable for development and
testing only. The default Helm chart configuration **does not meet production
security requirements**. For production deployments, you must review and
customize security settings including authentication, authorization, TLS
encryption, and network policies.
+
+:::
+
+## Prerequisites
+
+- Kubernetes server 1.25.0+ ([latest stable
version](https://kubernetes.io/releases/patch-releases/#detailed-release-history-for-active-branches)
recommended)
+- kubectl version that is compatible with your k8s server version ([+/- 1
minor release
version](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#before-you-begin))
+- Helm 3.12+ (choose a [helm version that is compatible with your k8s server
version](https://helm.sh/docs/topics/version_skew/#supported-version-skew))
+- At least 8GB of available RAM in your Kubernetes cluster
+- At least 20GB of persistent storage available
:::tip
@@ -32,10 +40,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/)
in this quick start
1. Create a Kubernetes cluster on Minikube.
```bash
- minikube start --memory=8192 --cpus=4 --kubernetes-version=<k8s-version>
+ minikube start --memory=8192 --cpus=4
```
- The `<k8s-version>` can be any [Kubernetes version supported by your
Minikube
installation](https://minikube.sigs.k8s.io/docs/reference/configuration/kubernetes/),
such as `v1.16.1`.
2. Set `kubectl` to use Minikube.
diff --git a/versioned_docs/version-4.0.x/getting-started-standalone.md
b/versioned_docs/version-4.0.x/getting-started-standalone.md
index 1f6be940d0e..fce374d92a7 100644
--- a/versioned_docs/version-4.0.x/getting-started-standalone.md
+++ b/versioned_docs/version-4.0.x/getting-started-standalone.md
@@ -19,7 +19,13 @@ To run Pulsar in standalone mode on your machine, follow the
steps below.
Currently, Pulsar is available for 64-bit **macOS** and **Linux**. See [Run
Pulsar In Docker](getting-started-docker.md) if you want to run Pulsar on
**Windows**.
-Also, you need the proper 64-bit JRE/JDK version installed. Please refer to
[Pulsar Runtime Java Version
Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation).
+Also, you need the proper 64-bit JRE/JDK version installed:
+
+- **Java 17** is required for Pulsar 2.11+ and master branch
+- **Java 11** is required for Pulsar 2.8/2.9/2.10
+- **Java 8** is required for Pulsar 2.7 and earlier
+
+For the latest Java version recommendations, see [Pulsar Runtime Java Version
Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation).
## Step 1: Download Pulsar distribution
diff --git a/versioned_docs/version-4.0.x/standalone-docker.md
b/versioned_docs/version-4.0.x/standalone-docker.md
index 32f303b799f..524f6dce4cf 100644
--- a/versioned_docs/version-4.0.x/standalone-docker.md
+++ b/versioned_docs/version-4.0.x/standalone-docker.md
@@ -6,7 +6,11 @@ sidebar_label: "Run Pulsar in Docker"
For local development and testing, you can run Pulsar in standalone mode on
your own machine within a Docker container.
-If you have not installed Docker, download it following [the
instructions](https://docs.docker.com/get-docker/) for your OS.
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) (version 20.10+ recommended)
+- At least 4GB of available RAM
+- At least 5GB of free disk space
## Start Pulsar in Docker
diff --git a/versioned_docs/version-4.1.x/getting-started-docker-compose.md
b/versioned_docs/version-4.1.x/getting-started-docker-compose.md
index 10f8d350324..eeceaecd586 100644
--- a/versioned_docs/version-4.1.x/getting-started-docker-compose.md
+++ b/versioned_docs/version-4.1.x/getting-started-docker-compose.md
@@ -7,6 +7,13 @@ description: Get started with Apache Pulsar on your local
machine using Docker C
To run Pulsar locally with Docker Compose, follow the steps below.
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) (version 20.10+ recommended)
+- [Docker Compose](https://docs.docker.com/compose/install/) (version 2.0+
recommended)
+- At least 8GB of available RAM for the cluster
+- At least 10GB of free disk space
+
## Step 1: Configure the `compose.yml` template
To get up and run a Pulsar cluster quickly, you can use the following template
to create a `compose.yml` file by modifying or adding the configurations in the
**environment** section.
@@ -31,11 +38,11 @@ services:
- PULSAR_MEM=-Xms256m -Xmx256m -XX:MaxDirectMemorySize=256m
command:
- bash
- - -c
+ - -c
- |
bin/apply-config-from-env.py conf/zookeeper.conf && \
bin/generate-zookeeper-config.sh conf/zookeeper.conf && \
- exec bin/pulsar zookeeper
+ exec bin/pulsar zookeeper
healthcheck:
test: ["CMD", "bin/pulsar-zookeeper-ruok.sh"]
interval: 10s
@@ -51,7 +58,7 @@ services:
- pulsar
command:
- bash
- - -c
+ - -c
- |
bin/pulsar initialize-cluster-metadata \
--cluster cluster-a \
diff --git a/versioned_docs/version-4.1.x/getting-started-docker.md
b/versioned_docs/version-4.1.x/getting-started-docker.md
index 302ebbf007e..a0f8daac01b 100644
--- a/versioned_docs/version-4.1.x/getting-started-docker.md
+++ b/versioned_docs/version-4.1.x/getting-started-docker.md
@@ -12,7 +12,11 @@ import TabItem from '@theme/TabItem';
For local development and testing, you can run Pulsar in standalone mode on
your own machine within a Docker container.
-If you have not installed Docker, download it following [the
instructions](https://docs.docker.com/get-docker/) for your OS.
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) (version 20.10+ recommended)
+- At least 4GB of available RAM
+- At least 5GB of free disk space
To run Pulsar in Docker, follow the steps below.
@@ -58,9 +62,9 @@ bin/pulsar standalone
:::tip
-You may encounter issues with the default RocksDB metadata store.
+By default, Pulsar uses RocksDB as the metadata store, which is recommended
for standalone instances.
-We recommend you consider using the following environment variable to use
ZooKeeper as the metadata store:
+If you encounter issues with RocksDB or need compatibility with existing
ZooKeeper-based installations, you can use ZooKeeper as the metadata store by
adding:
```
...
@@ -68,7 +72,7 @@ We recommend you consider using the following environment
variable to use ZooKee
...
```
-Don't apply this fix for existing Pulsar standalone instances if you don't
want to loose your data.
+Note: Switching metadata stores will create a new cluster. Don't apply this to
existing instances unless you want to start fresh.
:::
diff --git a/versioned_docs/version-4.1.x/getting-started-helm.md
b/versioned_docs/version-4.1.x/getting-started-helm.md
index 589f7b81e1c..e9715e0a3f5 100644
--- a/versioned_docs/version-4.1.x/getting-started-helm.md
+++ b/versioned_docs/version-4.1.x/getting-started-helm.md
@@ -9,11 +9,19 @@ This section guides you through every step of installing and
running Apache Puls
For deploying a Pulsar cluster for production usage, read the documentation on
[how to configure and install a Pulsar Helm chart](helm-deploy.md).
-## Prerequisite
+:::warning Security Notice
-- Kubernetes server 1.21.0+
-- kubectl 1.21.0+
-- Helm 3.10+
+This quickstart guide uses default configurations suitable for development and
testing only. The default Helm chart configuration **does not meet production
security requirements**. For production deployments, you must review and
customize security settings including authentication, authorization, TLS
encryption, and network policies.
+
+:::
+
+## Prerequisites
+
+- Kubernetes server 1.25.0+ ([latest stable
version](https://kubernetes.io/releases/patch-releases/#detailed-release-history-for-active-branches)
recommended)
+- kubectl version that is compatible with your k8s server version ([+/- 1
minor release
version](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#before-you-begin))
+- Helm 3.12+ (choose a [helm version that is compatible with your k8s server
version](https://helm.sh/docs/topics/version_skew/#supported-version-skew))
+- At least 8GB of available RAM in your Kubernetes cluster
+- At least 20GB of persistent storage available
:::tip
@@ -32,10 +40,9 @@ We use [Minikube](https://minikube.sigs.k8s.io/docs/start/)
in this quick start
1. Create a Kubernetes cluster on Minikube.
```bash
- minikube start --memory=8192 --cpus=4 --kubernetes-version=<k8s-version>
+ minikube start --memory=8192 --cpus=4
```
- The `<k8s-version>` can be any [Kubernetes version supported by your
Minikube
installation](https://minikube.sigs.k8s.io/docs/reference/configuration/kubernetes/),
such as `v1.16.1`.
2. Set `kubectl` to use Minikube.
diff --git a/versioned_docs/version-4.1.x/getting-started-standalone.md
b/versioned_docs/version-4.1.x/getting-started-standalone.md
index 1f6be940d0e..fce374d92a7 100644
--- a/versioned_docs/version-4.1.x/getting-started-standalone.md
+++ b/versioned_docs/version-4.1.x/getting-started-standalone.md
@@ -19,7 +19,13 @@ To run Pulsar in standalone mode on your machine, follow the
steps below.
Currently, Pulsar is available for 64-bit **macOS** and **Linux**. See [Run
Pulsar In Docker](getting-started-docker.md) if you want to run Pulsar on
**Windows**.
-Also, you need the proper 64-bit JRE/JDK version installed. Please refer to
[Pulsar Runtime Java Version
Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation).
+Also, you need the proper 64-bit JRE/JDK version installed:
+
+- **Java 17** is required for Pulsar 2.11+ and master branch
+- **Java 11** is required for Pulsar 2.8/2.9/2.10
+- **Java 8** is required for Pulsar 2.7 and earlier
+
+For the latest Java version recommendations, see [Pulsar Runtime Java Version
Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation).
## Step 1: Download Pulsar distribution
diff --git a/versioned_docs/version-4.1.x/standalone-docker.md
b/versioned_docs/version-4.1.x/standalone-docker.md
index 32f303b799f..524f6dce4cf 100644
--- a/versioned_docs/version-4.1.x/standalone-docker.md
+++ b/versioned_docs/version-4.1.x/standalone-docker.md
@@ -6,7 +6,11 @@ sidebar_label: "Run Pulsar in Docker"
For local development and testing, you can run Pulsar in standalone mode on
your own machine within a Docker container.
-If you have not installed Docker, download it following [the
instructions](https://docs.docker.com/get-docker/) for your OS.
+## Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) (version 20.10+ recommended)
+- At least 4GB of available RAM
+- At least 5GB of free disk space
## Start Pulsar in Docker
