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/13 03:06:46 UTC
[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
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