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/10/12 08:47:24 UTC
[GitHub] [pulsar] momo-jun opened a new pull request, #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
momo-jun opened a new pull request, #18015:
URL: https://github.com/apache/pulsar/pull/18015
### Motivation
The [Kubernetes (Helm)](https://pulsar.apache.org/docs/helm-overview) chapter mainly talks about the deployment. There are many unnecessary Xrefs, for example, the [deployment](https://pulsar.apache.org/docs/next/deploy-kubernetes) topic only provides an Xref to the installation topic, and then links to the deployment using helm. In addition, many topics inside also have inappropriate content chunks, for example, the major content of the Install and Required Tools topics belong to the Prepare topic.
This PR is to re-sort the information and incorporate the content into the Deployment chapter with a lean structure.
The content mapping is as follows.
<img width="536" alt="image" src="https://user-images.githubusercontent.com/60642177/195290358-c0a95c20-5c53-46a1-9da8-a0d9a5a2c3e5.png">
Ref: [Pre-discussion](https://github.com/apache/pulsar/discussions/17866).
### Modifications
1. Relocate the K8S content to the Deployment chapter according to the above content mapping.
2. Re-org the Overview/Prepare/Deploy/Upgrade topics.
3. Map the content in the original Install/Tools topics into the Deploy/Prepare topics.
4. Redirect the original Overview/Install/Tools topics to the new topics inside the Deployment chapter.
5. Refresh the sidebar and internal reference links.
6. Add a deprecation notice to the old "Get started with Kubernetes" topic.
### Verifying this change
**Overview**
<img width="1417" alt="image" src="https://user-images.githubusercontent.com/60642177/195291869-c7e9d29a-d642-4850-827d-0cf9fdf360aa.png">
**Prepare**
<img width="1719" alt="image" src="https://user-images.githubusercontent.com/60642177/195291757-a771c366-5dc3-4fd4-bf1f-53891f7fb395.png">
**Deploy**
<img width="1649" alt="image" src="https://user-images.githubusercontent.com/60642177/195291643-4ba6a259-e942-42d5-b4fe-ddaf67775459.png">
**Upgrade**
<img width="1430" alt="image" src="https://user-images.githubusercontent.com/60642177/195291982-626fc0aa-1c65-4b9f-8777-2c89522036bb.png">
### Documentation
- [x] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `sh start.sh` at `pulsar/site2/website`) to your PR description, or else your PR might not get merged. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- 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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1015052526
##########
site2/docs/helm-deploy.md:
##########
@@ -330,19 +323,15 @@ cd pulsar-helm-chart
The `prepare_helm_release` creates the following resources:
Review Comment:
@michaeljmarshall thanks for the information. The [`Get started`](https://pulsar.apache.org/docs/next/getting-started-helm#step-1-install-pulsar-helm-chart) topic also introduces this script to create secrets. If we don't recommend users run it, what's the alternative used to create secrets?
--
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] michaeljmarshall commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1014471393
##########
site2/docs/helm-deploy.md:
##########
@@ -131,49 +128,49 @@ The Pulsar Helm chart is designed to enable controlled upgrades. So it can confi
images:
zookeeper:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
bookie:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
autorecovery:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
broker:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
proxy:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
functions:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
prometheus:
repository: prom/prometheus
- tag: v1.6.3
+ tag: v2.17.2
pullPolicy: IfNotPresent
grafana:
repository: streamnative/apache-pulsar-grafana-dashboard-k8s
- tag: 0.0.4
+ tag: 0.0.16
pullPolicy: IfNotPresent
Review Comment:
We no longer deploy these components this way. We can remove this section.
Configuration for prometheus and grafana is governed by https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack. It just needs to be in the `kube-prometheus-stack:` section of the values.yaml file.
##########
site2/docs/helm-deploy.md:
##########
@@ -330,19 +323,15 @@ cd pulsar-helm-chart
The `prepare_helm_release` creates the following resources:
Review Comment:
This script was not maintained, so it was removed from the README here https://github.com/apache/pulsar-helm-chart/pull/324. There are appropriate instructions in that PR that could be copied to this section. The current README in https://github.com/apache/pulsar-helm-chart should work, too.
##########
site2/docs/helm-deploy.md:
##########
@@ -131,47 +134,47 @@ The Pulsar Helm chart is designed to enable controlled upgrades. So it can confi
images:
zookeeper:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
bookie:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
autorecovery:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
broker:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
proxy:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
functions:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
prometheus:
Review Comment:
This section looks good to me.
--
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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000064874
##########
site2/docs/helm-prepare.md:
##########
@@ -4,34 +4,44 @@ title: Prepare Kubernetes resources
sidebar_label: "Prepare"
---
-For a fully functional Pulsar cluster, you need a few resources before deploying the Apache Pulsar Helm chart. The following provides instructions to prepare the Kubernetes cluster before deploying the Pulsar Helm chart.
+For a fully functional Pulsar cluster, you need a few resources before deploying the Apache Pulsar Helm chart. This guide provides instructions to prepare the Kubernetes cluster before deploying the Pulsar Helm chart.
-- [Google Kubernetes Engine](#google-kubernetes-engine)
- - [Manual cluster creation](#manual-cluster-creation)
- - [Scripted cluster creation](#scripted-cluster-creation)
- - [Create cluster with local SSDs](#create-cluster-with-local-ssds)
+## Prerequisites
-## Google Kubernetes Engine
+Set up your environment by installing the required tools.
-To get started easier, a script is provided to create the cluster automatically. Alternatively, a cluster can be created manually as well.
+### Install kubectl
-### Manual cluster creation
+`kubectl` 1.18 or higher is the required tool that talks to the Kubernetes API. It needs to be compatible with your cluster ([+/- 1 minor release from your cluster](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin)). The server version of `kubectl` cannot be obtained until you connect to a cluster.
+
+For the installation instructions, see the [Kubernetes documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl).
+
+### Install Helm
+
+Helm is the package manager for Kubernetes. The Apache Pulsar Helm Chart is supported with Helm v3 (3.0.2 or higher).
+
+You can get the Helm from the project's [releases page](https://github.com/helm/helm/releases), or follow other options under the official documentation of [installing Helm](https://helm.sh/docs/intro/install/).
+
+
+## Create Kubernetes cluster
+
+A Kubernetes cluster version 1.18 or higher is required for continuing the deployment. To create a cluster, you can either use a script to automate the process or manually do it.
+
+### Create a cluster manually
Review Comment:
I suggest removing the "Create a cluster manually" here cause I don't think there is a relationship between the GKE and K8s manually provision.
Just keep the part "Create Kubernetes cluster" and you can link the official document link from Kubernetes https://kubernetes.io/docs/setup/production-environment/tools/ how to provision a cluster.
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000061252
##########
site2/docs/helm-deploy.md:
##########
@@ -376,3 +375,23 @@ To find the IP addresses of those components, run the following command:
kubectl get service -n <k8s-namespace>
```
+## Troubleshoot
+
+Although we have done our best to make these charts as seamless as possible, troubles do go out of our control occasionally. We have been collecting tips and tricks for troubleshooting common issues. Check it first before raising an [issue](https://github.com/apache/pulsar/issues/new/choose), and feel free to add your solutions by creating a [Pull Request](https://github.com/apache/pulsar/compare).
+
+
+## Uninstall
+
+To uninstall the Pulsar Helm chart, run the following command:
+
+```bash
+helm delete <pulsar-release-name>
Review Comment:
@ericsyh Thanks for the catch.
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000286554
##########
site2/docs/helm-prepare.md:
##########
@@ -4,34 +4,44 @@ title: Prepare Kubernetes resources
sidebar_label: "Prepare"
---
-For a fully functional Pulsar cluster, you need a few resources before deploying the Apache Pulsar Helm chart. The following provides instructions to prepare the Kubernetes cluster before deploying the Pulsar Helm chart.
+For a fully functional Pulsar cluster, you need a few resources before deploying the Apache Pulsar Helm chart. This guide provides instructions to prepare the Kubernetes cluster before deploying the Pulsar Helm chart.
-- [Google Kubernetes Engine](#google-kubernetes-engine)
- - [Manual cluster creation](#manual-cluster-creation)
- - [Scripted cluster creation](#scripted-cluster-creation)
- - [Create cluster with local SSDs](#create-cluster-with-local-ssds)
+## Prerequisites
-## Google Kubernetes Engine
+Set up your environment by installing the required tools.
-To get started easier, a script is provided to create the cluster automatically. Alternatively, a cluster can be created manually as well.
+### Install kubectl
-### Manual cluster creation
+`kubectl` 1.18 or higher is the required tool that talks to the Kubernetes API. It needs to be compatible with your cluster ([+/- 1 minor release from your cluster](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin)). The server version of `kubectl` cannot be obtained until you connect to a cluster.
+
+For the installation instructions, see the [Kubernetes documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl).
+
+### Install Helm
+
+Helm is the package manager for Kubernetes. The Apache Pulsar Helm Chart is supported with Helm v3 (3.0.2 or higher).
+
+You can get the Helm from the project's [releases page](https://github.com/helm/helm/releases), or follow other options under the official documentation of [installing Helm](https://helm.sh/docs/intro/install/).
+
+
+## Create Kubernetes cluster
+
+A Kubernetes cluster version 1.18 or higher is required for continuing the deployment. To create a cluster, you can either use a script to automate the process or manually do it.
+
+### Create a cluster manually
Review Comment:
Makes sense. Thanks for adding these comments!
--
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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000065955
##########
site2/docs/helm-prepare.md:
##########
@@ -63,11 +73,10 @@ The script can also be used to clean up the created GKE resources.
PROJECT=<gcloud project id> scripts/pulsar/gke_bootstrap_script.sh down
```
-#### Create cluster with local SSDs
+#### Create a cluster with local SSDs
Review Comment:
Suggest removing this part also.
--
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] tisonkun merged pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
tisonkun merged PR #18015:
URL: https://github.com/apache/pulsar/pull/18015
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r994065210
##########
site2/docs/helm-deploy.md:
##########
@@ -1,17 +1,20 @@
---
id: helm-deploy
-title: Deploy Pulsar cluster using Helm
-sidebar_label: "Deployment"
+title: Deploy a Pulsar cluster on Kubernetes
+sidebar_label: "Deploy"
---
-Before running `helm install`, you need to decide how to run Pulsar.
-Options can be specified using Helm's `--set option.name=value` command line option.
+Before deploying a Pulsar cluster, you need to [prepare Kubernetes resources](helm-prepare.md) and then continue with the following steps.
+1. Select configuration options
+2. Install dependent charts
+3. Prepare Helm release
+4. Deploy your Pulsar cluster using Helm
## Select configuration options
-In each section, collect the options that are combined to use with the `helm install` command.
+Specify how to run Pulsar using Helm's `--set option.name=value` command line option. In each section, collect the options that are combined to use with the `helm install` command.
-### Kubernetes namespace
+#### Kubernetes namespace
Review Comment:
Why use #### instead of ###? Is this an intended behavior for not showing the heading on the right navigation?
##########
site2/docs/helm-deploy.md:
##########
@@ -304,9 +307,9 @@ helm repo update
helm install pulsar-storage-provisioner streamnative/local-storage-provisioner
```
-### Install cert-manager
+#### Install cert-manager
-The Pulsar Helm chart uses the [cert-manager](https://github.com/jetstack/cert-manager) to provision and manage TLS certificates automatically. To enable TLS encryption for brokers or proxies, you need to install the cert-manager in advance.
+The Pulsar Helm chart uses the [cert-manager](https://github.com/jetstack/cert-manager) to provision and manages TLS certificates automatically. To enable TLS encryption for brokers or proxies, you need to install the cert-manager in advance.
Review Comment:
```suggestion
The Pulsar Helm chart uses the [cert-manager](https://github.com/jetstack/cert-manager) to provision and manage TLS certificates automatically. To enable TLS encryption for brokers or proxies, you need to install the cert-manager in advance.
```
use xxx to provision and manage
##########
site2/docs/helm-deploy.md:
##########
@@ -376,3 +375,23 @@ To find the IP addresses of those components, run the following command:
kubectl get service -n <k8s-namespace>
```
+## Troubleshooting
+
+Although we have done our best to make these charts as seamless as possible, troubles do go out of our control occasionally. We have been collecting tips and tricks for troubleshooting common issues. Please check it first before raising an [issue](https://github.com/apache/pulsar/issues/new/choose), and feel free to add your solutions by creating a [Pull Request](https://github.com/apache/pulsar/compare).
Review Comment:
```suggestion
Although we have done our best to make these charts as seamless as possible, troubles do go out of our control occasionally. We have been collecting tips and tricks for troubleshooting common issues. Check it first before raising an [issue](https://github.com/apache/pulsar/issues/new/choose), and feel free to add your solutions by creating a [Pull Request](https://github.com/apache/pulsar/compare).
```
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1009183876
##########
site2/docs/helm-deploy.md:
##########
@@ -284,15 +287,15 @@ To enable authorization, you can include this option in the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
By default, the resource requests and the number of replicas for the Pulsar components in the Pulsar Helm chart are adequate for small production deployment. If you deploy a non-production instance, you can reduce the defaults to fit into a smaller cluster.
Once you have all of your configuration options collected, you can install dependent charts before installing the Pulsar Helm chart.
## Install dependent charts
-### Install local storage provisioner
+#### Install local storage provisioner
Review Comment:
@ericsyh sorry for my late response. After a revisit, I understand this `Install local storage provisioner` section as an optional task to perform only if users want to use the local persistent volumes as the persistent storage. Otherwise, they don't need to install any local storage provisioner. Does it make sense to understand this way?
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1009184650
##########
site2/docs/helm-deploy.md:
##########
@@ -131,47 +134,47 @@ The Pulsar Helm chart is designed to enable controlled upgrades. So it can confi
images:
zookeeper:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
bookie:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
autorecovery:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
broker:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
proxy:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
functions:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
prometheus:
Review Comment:
@michaeljmarshall did you see any updates to be addressed in these docs following the changes you made to the helm chart?
--
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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1013620789
##########
site2/docs/helm-deploy.md:
##########
@@ -284,15 +287,15 @@ To enable authorization, you can include this option in the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
By default, the resource requests and the number of replicas for the Pulsar components in the Pulsar Helm chart are adequate for small production deployment. If you deploy a non-production instance, you can reduce the defaults to fit into a smaller cluster.
Once you have all of your configuration options collected, you can install dependent charts before installing the Pulsar Helm chart.
## Install dependent charts
-### Install local storage provisioner
+#### Install local storage provisioner
Review Comment:
Somehow is correct but I don't think it's an optional task because there is no binding relationship between using local persistent volumes and installing `streamnative/local-storage-provisioner`.
If I want to deploy `pulsar-helm-chart` on k8s with local persistent volumes, there are some provisioners to choose from:
* https://github.com/rancher/local-path-provisioner
* https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner, actually it is the upstream of ` streamnative/local-storage-provisioner`
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000513775
##########
site2/docs/helm-deploy.md:
##########
@@ -284,15 +287,15 @@ To enable authorization, you can include this option in the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
By default, the resource requests and the number of replicas for the Pulsar components in the Pulsar Helm chart are adequate for small production deployment. If you deploy a non-production instance, you can reduce the defaults to fit into a smaller cluster.
Once you have all of your configuration options collected, you can install dependent charts before installing the Pulsar Helm chart.
## Install dependent charts
-### Install local storage provisioner
+#### Install local storage provisioner
Review Comment:
@ericsyh It also has a counterpart in the [Persistence](https://pulsar.apache.org/docs/next/helm-deploy#persistence) section and even a parameter named `local_storage`. Should this part be updated as well?
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000513775
##########
site2/docs/helm-deploy.md:
##########
@@ -284,15 +287,15 @@ To enable authorization, you can include this option in the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
By default, the resource requests and the number of replicas for the Pulsar components in the Pulsar Helm chart are adequate for small production deployment. If you deploy a non-production instance, you can reduce the defaults to fit into a smaller cluster.
Once you have all of your configuration options collected, you can install dependent charts before installing the Pulsar Helm chart.
## Install dependent charts
-### Install local storage provisioner
+#### Install local storage provisioner
Review Comment:
@ericsyh It also has a counterpart in the [Persistent](https://pulsar.apache.org/docs/next/helm-deploy#persistence) section and even a parameter named `local_storage`. Should this part be updated as well?
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1015052526
##########
site2/docs/helm-deploy.md:
##########
@@ -330,19 +323,15 @@ cd pulsar-helm-chart
The `prepare_helm_release` creates the following resources:
Review Comment:
@michaeljmarshall thanks for the information. This script still exists in the [Uninstall](https://github.com/apache/pulsar-helm-chart#uninstall) section of the README file.
The [`Get started`](https://pulsar.apache.org/docs/next/getting-started-helm#step-1-install-pulsar-helm-chart) topic also introduces this script to create secrets. If we don't recommend users run it, what's the alternative used to create secrets?
--
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 pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#issuecomment-1282245149
@zymap @mattisonchao can you pls review this PR from a technical perspective? Thank you.
--
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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000065808
##########
site2/docs/helm-prepare.md:
##########
@@ -4,34 +4,44 @@ title: Prepare Kubernetes resources
sidebar_label: "Prepare"
---
-For a fully functional Pulsar cluster, you need a few resources before deploying the Apache Pulsar Helm chart. The following provides instructions to prepare the Kubernetes cluster before deploying the Pulsar Helm chart.
+For a fully functional Pulsar cluster, you need a few resources before deploying the Apache Pulsar Helm chart. This guide provides instructions to prepare the Kubernetes cluster before deploying the Pulsar Helm chart.
-- [Google Kubernetes Engine](#google-kubernetes-engine)
- - [Manual cluster creation](#manual-cluster-creation)
- - [Scripted cluster creation](#scripted-cluster-creation)
- - [Create cluster with local SSDs](#create-cluster-with-local-ssds)
+## Prerequisites
-## Google Kubernetes Engine
+Set up your environment by installing the required tools.
-To get started easier, a script is provided to create the cluster automatically. Alternatively, a cluster can be created manually as well.
+### Install kubectl
-### Manual cluster creation
+`kubectl` 1.18 or higher is the required tool that talks to the Kubernetes API. It needs to be compatible with your cluster ([+/- 1 minor release from your cluster](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin)). The server version of `kubectl` cannot be obtained until you connect to a cluster.
+
+For the installation instructions, see the [Kubernetes documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl).
+
+### Install Helm
+
+Helm is the package manager for Kubernetes. The Apache Pulsar Helm Chart is supported with Helm v3 (3.0.2 or higher).
+
+You can get the Helm from the project's [releases page](https://github.com/helm/helm/releases), or follow other options under the official documentation of [installing Helm](https://helm.sh/docs/intro/install/).
+
+
+## Create Kubernetes cluster
+
+A Kubernetes cluster version 1.18 or higher is required for continuing the deployment. To create a cluster, you can either use a script to automate the process or manually do it.
+
+### Create a cluster manually
To provision a Kubernetes cluster manually, follow the [GKE instructions](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster).
-### Scripted cluster creation
+### Create a cluster using a bootstrap script
Review Comment:
This part should be removed also. There is no need for the `apache/pulsar` document to introduce the steps of how to provision the Kubernetes cluster.
--
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] dave2wave commented on pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
dave2wave commented on PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#issuecomment-1287951770
@michaeljmarshall Is working through updating the Apache Pulsar Helm Chart and has started a VOTE on a release. Clearly once that is done some of these changes will need to be revisited.
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000288986
##########
site2/docs/deploy-kubernetes.md:
##########
@@ -1,10 +1,39 @@
---
id: deploy-kubernetes
-title: Deploy Pulsar on Kubernetes
+title: Overview
sidebar_label: "Kubernetes"
---
-To get up and running with these charts as fast as possible, in a **non-production** use case, we provide
-a [quick start guide](getting-started-helm.md) for Proof of Concept (PoC) deployments.
+The Apache Pulsar [Helm chart](https://github.com/apache/pulsar-helm-chart) provides one of the most convenient ways to deploy and operate Pulsar on Kubernetes. With all the required components, the Helm chart is scalable and thus suitable for large-scale deployments.
-To configure and install a Pulsar cluster on Kubernetes for production usage, follow the complete [Installation Guide](helm-install.md).
\ No newline at end of file
+The Apache Pulsar Helm chart contains all components to support the features and functions that Pulsar delivers. You can install and configure these components separately.
+
+- Pulsar core components
+ - ZooKeeper
+ - Bookies
+ - Brokers
+ - Function workers
+ - Proxies
+- Control center
+ - Pulsar Manager
+ - Prometheus
+ - Grafana
+
+
+## What's Next?
+
+* To get up and running with Pulsar Helm chart as fast as possible for Proof of Concept (PoC) in a **non-production** use case, see the [quick start guide](getting-started-helm.md).
Review Comment:
I think it's okay to leave the link here as a quick start option and it's up to the readers to the next move.
--
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] tisonkun commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1013666001
##########
site2/docs/helm-deploy.md:
##########
@@ -131,47 +134,47 @@ The Pulsar Helm chart is designed to enable controlled upgrades. So it can confi
images:
zookeeper:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
bookie:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
autorecovery:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
broker:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
proxy:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
functions:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
prometheus:
Review Comment:
ping @michaeljmarshall
Since Pulsar Helm Charts 3.0.0 has been released, could you review this part of documents?
--
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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000068134
##########
site2/docs/deploy-kubernetes.md:
##########
@@ -1,10 +1,39 @@
---
id: deploy-kubernetes
-title: Deploy Pulsar on Kubernetes
+title: Overview
sidebar_label: "Kubernetes"
---
-To get up and running with these charts as fast as possible, in a **non-production** use case, we provide
-a [quick start guide](getting-started-helm.md) for Proof of Concept (PoC) deployments.
+The Apache Pulsar [Helm chart](https://github.com/apache/pulsar-helm-chart) provides one of the most convenient ways to deploy and operate Pulsar on Kubernetes. With all the required components, the Helm chart is scalable and thus suitable for large-scale deployments.
-To configure and install a Pulsar cluster on Kubernetes for production usage, follow the complete [Installation Guide](helm-install.md).
\ No newline at end of file
+The Apache Pulsar Helm chart contains all components to support the features and functions that Pulsar delivers. You can install and configure these components separately.
+
+- Pulsar core components
+ - ZooKeeper
+ - Bookies
+ - Brokers
+ - Function workers
+ - Proxies
+- Control center
+ - Pulsar Manager
+ - Prometheus
+ - Grafana
+
+
+## What's Next?
+
+* To get up and running with Pulsar Helm chart as fast as possible for Proof of Concept (PoC) in a **non-production** use case, see the [quick start guide](getting-started-helm.md).
Review Comment:
I suggest removing this "quick start guide" cause https://pulsar.apache.org/docs/getting-started-helm just shows a sample of how to install `pulsar-helm-chart` on minikube which is very similar to the formal installation https://pulsar.apache.org/docs/helm-deploy. I'd like to remove the "quick start" and just keep the formal installation.
--
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] ericsyh commented on pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#issuecomment-1284808860
I think there are some inaccurate descriptions on the `pulsar-helm-chart` documents. I left on comments on them.
--
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] dave2wave commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
dave2wave commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1002602373
##########
site2/docs/helm-deploy.md:
##########
@@ -131,47 +134,47 @@ The Pulsar Helm chart is designed to enable controlled upgrades. So it can confi
images:
zookeeper:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
bookie:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
autorecovery:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
broker:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
proxy:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
pullPolicy: IfNotPresent
functions:
repository: apachepulsar/pulsar-all
- tag: 2.5.0
+ tag: @pulsar:version@
prometheus:
Review Comment:
@michaeljmarshall I believe you have updated many of these tags and repositories.
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1013644904
##########
site2/docs/helm-deploy.md:
##########
@@ -284,15 +287,15 @@ To enable authorization, you can include this option in the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
By default, the resource requests and the number of replicas for the Pulsar components in the Pulsar Helm chart are adequate for small production deployment. If you deploy a non-production instance, you can reduce the defaults to fit into a smaller cluster.
Once you have all of your configuration options collected, you can install dependent charts before installing the Pulsar Helm chart.
## Install dependent charts
-### Install local storage provisioner
+#### Install local storage provisioner
Review Comment:
Thanks for the clarification. The section has been updated. PTAL.
--
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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1013656965
##########
site2/docs/helm-deploy.md:
##########
@@ -49,25 +52,21 @@ volumes:
local_storage: false
```
-To use local persistent volumes as the persistent storage for Helm release, you can install the [local storage provisioner](#install-local-storage-provisioner) and include the following option in the `helm install` command.
-
-```bash
---set volumes.local_storage=true
-```
+If you want to use local persistent volumes as the persistent storage for Helm release, you can install a local storage provisioner and include `--set volumes.local_storage=true` in the `helm install` command. See [Install storage provisioner](#install-storage-provisioner) for more details.
Review Comment:
We can remove this part as we discussed.
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r994135171
##########
site2/docs/helm-deploy.md:
##########
@@ -1,17 +1,20 @@
---
id: helm-deploy
-title: Deploy Pulsar cluster using Helm
-sidebar_label: "Deployment"
+title: Deploy a Pulsar cluster on Kubernetes
+sidebar_label: "Deploy"
---
-Before running `helm install`, you need to decide how to run Pulsar.
-Options can be specified using Helm's `--set option.name=value` command line option.
+Before deploying a Pulsar cluster, you need to [prepare Kubernetes resources](helm-prepare.md) and then continue with the following steps.
+1. Select configuration options
+2. Install dependent charts
+3. Prepare Helm release
+4. Deploy your Pulsar cluster using Helm
## Select configuration options
-In each section, collect the options that are combined to use with the `helm install` command.
+Specify how to run Pulsar using Helm's `--set option.name=value` command line option. In each section, collect the options that are combined to use with the `helm install` command.
-### Kubernetes namespace
+#### Kubernetes namespace
Review Comment:
Yes, that's my intention to make the hot links simple and clean for general steps.
--
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] tisonkun commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1019774367
##########
site2/docs/helm-install.md:
##########
@@ -4,34 +4,8 @@ title: Install Apache Pulsar using Helm
sidebar_label: "Install "
---
-Install Apache Pulsar on Kubernetes with the official Pulsar Helm chart.
+````mdx-code-block
+import {Redirect} from '@docusaurus/router';
Review Comment:
FYI redirections should follow this pattern https://github.com/apache/pulsar/pull/18415#issue-1443829113.
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1019789503
##########
site2/docs/helm-install.md:
##########
@@ -4,34 +4,8 @@ title: Install Apache Pulsar using Helm
sidebar_label: "Install "
---
-Install Apache Pulsar on Kubernetes with the official Pulsar Helm chart.
+````mdx-code-block
+import {Redirect} from '@docusaurus/router';
Review Comment:
Thanks for the reminder. Done :)
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000513775
##########
site2/docs/helm-deploy.md:
##########
@@ -284,15 +287,15 @@ To enable authorization, you can include this option in the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
By default, the resource requests and the number of replicas for the Pulsar components in the Pulsar Helm chart are adequate for small production deployment. If you deploy a non-production instance, you can reduce the defaults to fit into a smaller cluster.
Once you have all of your configuration options collected, you can install dependent charts before installing the Pulsar Helm chart.
## Install dependent charts
-### Install local storage provisioner
+#### Install local storage provisioner
Review Comment:
@zymap can you pls review and confirm this point?
--
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 #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1001411481
##########
site2/docs/helm-deploy.md:
##########
@@ -284,15 +287,15 @@ To enable authorization, you can include this option in the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
By default, the resource requests and the number of replicas for the Pulsar components in the Pulsar Helm chart are adequate for small production deployment. If you deploy a non-production instance, you can reduce the defaults to fit into a smaller cluster.
Once you have all of your configuration options collected, you can install dependent charts before installing the Pulsar Helm chart.
## Install dependent charts
-### Install local storage provisioner
+#### Install local storage provisioner
Review Comment:
Is `create storage class and config the storage class` an alternative way to install the storage provisioned compared to the [recommended cmd](https://pulsar.apache.org/docs/next/helm-deploy#install-local-storage-provisioner) in the doc, or a subsequent step?
--
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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r999387959
##########
site2/docs/helm-deploy.md:
##########
@@ -376,3 +375,23 @@ To find the IP addresses of those components, run the following command:
kubectl get service -n <k8s-namespace>
```
+## Troubleshoot
+
+Although we have done our best to make these charts as seamless as possible, troubles do go out of our control occasionally. We have been collecting tips and tricks for troubleshooting common issues. Check it first before raising an [issue](https://github.com/apache/pulsar/issues/new/choose), and feel free to add your solutions by creating a [Pull Request](https://github.com/apache/pulsar/compare).
+
+
+## Uninstall
+
+To uninstall the Pulsar Helm chart, run the following command:
+
+```bash
+helm delete <pulsar-release-name>
Review Comment:
Should use the helm uninstall 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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000064874
##########
site2/docs/helm-prepare.md:
##########
@@ -4,34 +4,44 @@ title: Prepare Kubernetes resources
sidebar_label: "Prepare"
---
-For a fully functional Pulsar cluster, you need a few resources before deploying the Apache Pulsar Helm chart. The following provides instructions to prepare the Kubernetes cluster before deploying the Pulsar Helm chart.
+For a fully functional Pulsar cluster, you need a few resources before deploying the Apache Pulsar Helm chart. This guide provides instructions to prepare the Kubernetes cluster before deploying the Pulsar Helm chart.
-- [Google Kubernetes Engine](#google-kubernetes-engine)
- - [Manual cluster creation](#manual-cluster-creation)
- - [Scripted cluster creation](#scripted-cluster-creation)
- - [Create cluster with local SSDs](#create-cluster-with-local-ssds)
+## Prerequisites
-## Google Kubernetes Engine
+Set up your environment by installing the required tools.
-To get started easier, a script is provided to create the cluster automatically. Alternatively, a cluster can be created manually as well.
+### Install kubectl
-### Manual cluster creation
+`kubectl` 1.18 or higher is the required tool that talks to the Kubernetes API. It needs to be compatible with your cluster ([+/- 1 minor release from your cluster](https://kubernetes.io/docs/tasks/tools/install-kubectl/#before-you-begin)). The server version of `kubectl` cannot be obtained until you connect to a cluster.
+
+For the installation instructions, see the [Kubernetes documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl).
+
+### Install Helm
+
+Helm is the package manager for Kubernetes. The Apache Pulsar Helm Chart is supported with Helm v3 (3.0.2 or higher).
+
+You can get the Helm from the project's [releases page](https://github.com/helm/helm/releases), or follow other options under the official documentation of [installing Helm](https://helm.sh/docs/intro/install/).
+
+
+## Create Kubernetes cluster
+
+A Kubernetes cluster version 1.18 or higher is required for continuing the deployment. To create a cluster, you can either use a script to automate the process or manually do it.
+
+### Create a cluster manually
Review Comment:
I suggest removing the "Create a cluster manually" here cause I don't there is a relationship between the GKE and K8s manually provision.
Just keep the part of "Create Kubernetes cluster" and you can link the official document link from Kubernetes https://kubernetes.io/docs/setup/production-environment/tools/ how to provision a cluster.
--
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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1000072952
##########
site2/docs/helm-deploy.md:
##########
@@ -284,15 +287,15 @@ To enable authorization, you can include this option in the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
By default, the resource requests and the number of replicas for the Pulsar components in the Pulsar Helm chart are adequate for small production deployment. If you deploy a non-production instance, you can reduce the defaults to fit into a smaller cluster.
Once you have all of your configuration options collected, you can install dependent charts before installing the Pulsar Helm chart.
## Install dependent charts
-### Install local storage provisioner
+#### Install local storage provisioner
Review Comment:
I think this is not very accurate cause `pulsar-helm-chart` needs a storage provisioner but not must be a local storage provisioner. Users just need to create [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/) for their k8s cluster and config the storage class name in https://github.com/apache/pulsar-helm-chart/blob/master/charts/pulsar/values.yaml#L361
--
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] ericsyh commented on a diff in pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
ericsyh commented on code in PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#discussion_r1001671632
##########
site2/docs/helm-deploy.md:
##########
@@ -284,15 +287,15 @@ To enable authorization, you can include this option in the `helm install` comma
--set auth.authorization.enabled=true
```
-### CPU and RAM resource requirements
+#### CPU and RAM resource requirements
By default, the resource requests and the number of replicas for the Pulsar components in the Pulsar Helm chart are adequate for small production deployment. If you deploy a non-production instance, you can reduce the defaults to fit into a smaller cluster.
Once you have all of your configuration options collected, you can install dependent charts before installing the Pulsar Helm chart.
## Install dependent charts
-### Install local storage provisioner
+#### Install local storage provisioner
Review Comment:
> It also has a counterpart in the [Persistence](https://pulsar.apache.org/docs/next/helm-deploy#persistence) section and even a parameter named local_storage. Should this part be updated as well?
Yeah, I think this part should be updated also. `local_storage` config is for the `streamnative/local-storage-provisioner`.
> Is create storage class and config the storage class an alternative way to install the storage provisioned compared to the [recommended cmd](https://pulsar.apache.org/docs/next/helm-deploy#install-local-storage-provisioner) in the doc, or a subsequent step?
Creating a storage class and config the storage class is a more general way for storage provisioned. Actually, `helm install pulsar-storage-provisioner streamnative/local-storage-provisioner` is also to install `local-storage-provisioner` in kubernetes as a storage class.
--
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 pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#issuecomment-1278387875
@tjiuming can you pls review this PR from a tech perspective? Thank you.
//cc @DaveDuggins for editorial review.
--
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] tisonkun commented on pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#issuecomment-1282142658
Perhaps @ericsyh can give a review or specify someone who is familiar with these topics?
--
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] tjiuming commented on pull request #18015: [refactor][doc] Improve the IA of the Kubernetes chapter and merge into the deployment chapter
Posted by GitBox <gi...@apache.org>.
tjiuming commented on PR #18015:
URL: https://github.com/apache/pulsar/pull/18015#issuecomment-1281879427
@momo-jun sorry, I missed the PR, and I'm not familiar with helm chart
--
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