You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "codelipenghui (via GitHub)" <gi...@apache.org> on 2025/08/20 19:01:12 UTC
[PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
codelipenghui opened a new pull request, #1033:
URL: https://github.com/apache/pulsar-site/pull/1033
## Summary
- Update Getting Started documentation with comprehensive prerequisites and latest version requirements
- Enhance all deployment methods (standalone, Docker, Docker Compose, Kubernetes/Helm) with consistent formatting
- Add security warnings and resource requirements
## Changes Made
- **Java Requirements**: Added specific Java version requirements (Java 17 for Pulsar 2.11+, Java 11 for 2.8-2.10, Java 8 for 2.7-)
- **Docker Documentation**: Enhanced with prerequisites, resource requirements, and improved RocksDB vs ZooKeeper guidance
- **Docker Compose**: Added prerequisites section and replaced `:latest` tags with version placeholders
- **Helm/Kubernetes**: Added security warnings, updated version recommendations, and comprehensive prerequisites
- **Standalone Docker**: Added consistent prerequisite section
## Verification
- ✅ Verified latest Pulsar 4.0.6 Docker images available
- ✅ Confirmed Helm chart 4.2.0 repository accessibility
- ✅ Tested download URLs and external dependencies
- ✅ All installation procedures now have consistent prerequisite sections
## Test plan
- [x] Verify all external links and download URLs work correctly
- [x] Confirm Docker Hub images and Helm repositories are accessible
- [x] Check that all guides have consistent formatting and prerequisites
- [x] Ensure system requirements are appropriate for each deployment method
🤖 Generated with [Claude Code](https://claude.ai/code)
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330773105
##########
docs/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.21.0+ (1.24+ recommended)
+- kubectl 1.21.0+
Review Comment:
```suggestion
- kubectl version that is compatible with your cluster ([+/- 1 minor release from your k8s server version](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#before-you-begin))
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330773105
##########
docs/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.21.0+ (1.24+ recommended)
+- kubectl 1.21.0+
Review Comment:
```suggestion
- 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))
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330773105
##########
docs/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.21.0+ (1.24+ recommended)
+- kubectl 1.21.0+
Review Comment:
```suggestion
- kubectl 1.25.0+, compatible with your cluster ([+/- 1 minor release from your cluster](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/#before-you-begin))
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari merged PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330773105
##########
docs/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.21.0+ (1.24+ recommended)
+- kubectl 1.21.0+
Review Comment:
```suggestion
- kubectl 1.25.0+, compatible with your cluster ([+/- 1 minor release from your cluster](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin))
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330779548
##########
docs/getting-started-helm.md:
##########
@@ -32,10 +40,10 @@ 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 --kubernetes-version=v1.24.0
Review Comment:
```suggestion
minikube start --memory=8192 --cpus=4 --kubernetes-version=v1.32.8
```
##########
docs/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.21.0+ (1.24+ recommended)
Review Comment:
```suggestion
- Kubernetes server 1.25.0+ (1.32.8 recommended)
```
##########
docs/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.21.0+ (1.24+ recommended)
+- kubectl 1.21.0+
+- Helm 3.10+ (3.12+ recommended)
Review Comment:
```suggestion
- Helm 3.12+
```
##########
docs/getting-started-helm.md:
##########
@@ -32,10 +40,10 @@ 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 --kubernetes-version=v1.24.0
```
- 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`.
+ You can use any [Kubernetes version supported by your Minikube installation](https://minikube.sigs.k8s.io/docs/reference/configuration/kubernetes/). Version 1.24+ is recommended for better stability.
Review Comment:
```suggestion
You can use any [Kubernetes version >= v1.25.0 with the Minikube installation](https://minikube.sigs.k8s.io/docs/reference/configuration/kubernetes/). `stable` can be used to get the latest `stable` k8s version is recommended. It's also the default when `--kubernetes-version` parameter is omitted.
```
##########
docs/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.21.0+ (1.24+ recommended)
+- kubectl 1.21.0+
Review Comment:
```suggestion
- kubectl 1.25.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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330772649
##########
docs/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.21.0+ (1.24+ recommended)
Review Comment:
```suggestion
- Kubernetes server 1.25.0+ ([latest stable version](https://kubernetes.io/releases/patch-releases/#detailed-release-history-for-active-branches) recommended)
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330773720
##########
docs/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.21.0+ (1.24+ recommended)
+- kubectl 1.21.0+
+- Helm 3.10+ (3.12+ recommended)
Review Comment:
```suggestion
- 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))
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330808314
##########
docs/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.21.0+ (1.24+ recommended)
Review Comment:
EOL for 1.32.x is Feb 28th, 2026: https://kubernetes.io/releases/patch-releases/#1-32
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330772649
##########
docs/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.21.0+ (1.24+ recommended)
Review Comment:
```suggestion
- Kubernetes server 1.25.0+ (1.32.0+ recommended)
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330772649
##########
docs/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.21.0+ (1.24+ recommended)
Review Comment:
```suggestion
- Kubernetes server 1.25.0+ (latest stable version recommended)
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330784221
##########
docs/getting-started-helm.md:
##########
@@ -32,10 +40,10 @@ 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 --kubernetes-version=v1.24.0
```
- 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`.
+ You can use any [Kubernetes version supported by your Minikube installation](https://minikube.sigs.k8s.io/docs/reference/configuration/kubernetes/). Version 1.24+ is recommended for better stability.
Review Comment:
We can remove this since minikube will use the latest stable k8s version by default. That's fine for apache-pulsar-helmchart.
```suggestion
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330779548
##########
docs/getting-started-helm.md:
##########
@@ -32,10 +40,10 @@ 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 --kubernetes-version=v1.24.0
Review Comment:
There's no need to specify the k8s version since the latest stable version will get used by default.
```suggestion
minikube start --memory=8192 --cpus=4
```
--
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
Re: [PR] Update Getting Started documentation with latest requirements and best practices [pulsar-site]
Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1033:
URL: https://github.com/apache/pulsar-site/pull/1033#discussion_r2330779548
##########
docs/getting-started-helm.md:
##########
@@ -32,10 +40,10 @@ 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 --kubernetes-version=v1.24.0
Review Comment:
```suggestion
minikube start --memory=8192 --cpus=4
```
--
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