This is an automated email from the ASF dual-hosted git repository.
lhotari pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 70974d31e023 Fix out of date Helm documentation around monitoring
component customization (#927)
70974d31e023 is described below
commit 70974d31e023ff38a17063f3867f9c5d780ce501
Author: dmaiken <[email protected]>
AuthorDate: Wed Jul 3 05:33:13 2024 -0600
Fix out of date Helm documentation around monitoring component
customization (#927)
Co-authored-by: Daniel Aiken <[email protected]>
---
docs/helm-deploy.md | 55 +++++++++++++++++++++++++---
versioned_docs/version-2.10.x/helm-deploy.md | 25 +++++++++----
versioned_docs/version-2.11.x/helm-deploy.md | 24 +++++++++---
versioned_docs/version-3.0.x/helm-deploy.md | 24 +++++++++---
versioned_docs/version-3.1.x/helm-deploy.md | 24 +++++++++---
versioned_docs/version-3.2.x/helm-deploy.md | 24 +++++++++---
versioned_docs/version-3.3.x/helm-deploy.md | 24 +++++++++---
7 files changed, 157 insertions(+), 43 deletions(-)
diff --git a/docs/helm-deploy.md b/docs/helm-deploy.md
index 04b46e659d63..5be5ec2ac688 100644
--- a/docs/helm-deploy.md
+++ b/docs/helm-deploy.md
@@ -100,15 +100,27 @@ components:
toolset: true
# pulsar manager
pulsar_manager: true
+```
+
+##### Monitoring Components
+
+The Pulsar Helm Chart installs monitoring components using a dependent Helm
chart,
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts).
You can customize this Helm chart to specify which monitoring components to
install. These components are enabled by default.
+```yaml
## Monitoring Components
##
-## Control what components of the monitoring stack to deploy for the cluster
-monitoring:
- # monitoring - prometheus
- prometheus: true
- # monitoring - grafana
- grafana: true
+## Control what components of the kube-prometheus-stack Helm chart to deploy
for the cluster
+kube-prometheus-stack:
+ # Control deployment of this Helm chart entirely
+ enabled: true
+ # prometheus
+ prometheus:
+ enabled: true
+ promtheus-node-exporter:
+ enabled: true
+ # grafana
+ grafana:
+ enabled: true
```
#### Docker images
@@ -150,6 +162,26 @@ images:
hasCommand: false
```
+The Pulsar Helm Chart also lets you specify the image versions used by
initialization containers used to coordinate creation and connection of
dependent Pulsar resources.
+
+```yaml
+## Images
+##
+## Control what image to use for Pulsar init containers
+pulsar_metadata:
+ component: pulsar-init
+ image:
+ repository: apachepulsar/pulsar-all
+ tag: @pulsar:version@
+ pullPolicy: IfNotPresent
+```
+
+:::tip
+
+If using a private Docker repository or pull-thru cache, the `repository`
configuration option must be changed accordingly for all component defintions
including the `pulsar_metadata` component.
+
+:::
+
#### TLS
The Pulsar Helm Chart can be configured to enable TLS (Transport Layer
Security) to protect all the traffic between components. Before enabling TLS,
you have to provision TLS certificates for the required components.
@@ -353,6 +385,17 @@ To find the IP addresses of those components, run the
following command:
kubectl get service -n <k8s-namespace>
```
+You can configure the Proxy and the Pulsar Manager as a `NodePort` instead of
a `ClusterIP`.
+
+```yaml
+proxy:
+ service:
+ type: NodePort
+pulsar_manager:
+ service:
+ type: NodePort
+```
+
## 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).
diff --git a/versioned_docs/version-2.10.x/helm-deploy.md
b/versioned_docs/version-2.10.x/helm-deploy.md
index d4d0fcfafac9..50f562d8c310 100644
--- a/versioned_docs/version-2.10.x/helm-deploy.md
+++ b/versioned_docs/version-2.10.x/helm-deploy.md
@@ -129,16 +129,27 @@ components:
toolset: true
# pulsar manager
pulsar_manager: true
+```
+
+##### Monitoring Components
+The Pulsar Helm Chart installs monitoring components using a dependent Helm
chart,
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts).
You can customize this Helm chart to specify which monitoring components to
install. These components are enabled by default.
+
+```yaml
## Monitoring Components
##
-## Control what components of the monitoring stack to deploy for the cluster
-monitoring:
- # monitoring - prometheus
- prometheus: true
- # monitoring - grafana
- grafana: true
-
+## Control what components of the kube-prometheus-stack Helm chart to deploy
for the cluster
+kube-prometheus-stack:
+ # Control deployment of this Helm chart entirely
+ enabled: true
+ # prometheus
+ prometheus:
+ enabled: true
+ promtheus-node-exporter:
+ enabled: true
+ # grafana
+ grafana:
+ enabled: true
```
### Docker images
diff --git a/versioned_docs/version-2.11.x/helm-deploy.md
b/versioned_docs/version-2.11.x/helm-deploy.md
index f342d89a2a3f..50e1e3d98cb1 100644
--- a/versioned_docs/version-2.11.x/helm-deploy.md
+++ b/versioned_docs/version-2.11.x/helm-deploy.md
@@ -103,15 +103,27 @@ components:
toolset: true
# pulsar manager
pulsar_manager: true
+```
+
+##### Monitoring Components
+The Pulsar Helm Chart installs monitoring components using a dependent Helm
chart,
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts).
You can customize this Helm chart to specify which monitoring components to
install. These components are enabled by default.
+
+```yaml
## Monitoring Components
##
-## Control what components of the monitoring stack to deploy for the cluster
-monitoring:
- # monitoring - prometheus
- prometheus: true
- # monitoring - grafana
- grafana: true
+## Control what components of the kube-prometheus-stack Helm chart to deploy
for the cluster
+kube-prometheus-stack:
+ # Control deployment of this Helm chart entirely
+ enabled: true
+ # prometheus
+ prometheus:
+ enabled: true
+ promtheus-node-exporter:
+ enabled: true
+ # grafana
+ grafana:
+ enabled: true
```
#### Docker images
diff --git a/versioned_docs/version-3.0.x/helm-deploy.md
b/versioned_docs/version-3.0.x/helm-deploy.md
index f342d89a2a3f..50e1e3d98cb1 100644
--- a/versioned_docs/version-3.0.x/helm-deploy.md
+++ b/versioned_docs/version-3.0.x/helm-deploy.md
@@ -103,15 +103,27 @@ components:
toolset: true
# pulsar manager
pulsar_manager: true
+```
+
+##### Monitoring Components
+The Pulsar Helm Chart installs monitoring components using a dependent Helm
chart,
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts).
You can customize this Helm chart to specify which monitoring components to
install. These components are enabled by default.
+
+```yaml
## Monitoring Components
##
-## Control what components of the monitoring stack to deploy for the cluster
-monitoring:
- # monitoring - prometheus
- prometheus: true
- # monitoring - grafana
- grafana: true
+## Control what components of the kube-prometheus-stack Helm chart to deploy
for the cluster
+kube-prometheus-stack:
+ # Control deployment of this Helm chart entirely
+ enabled: true
+ # prometheus
+ prometheus:
+ enabled: true
+ promtheus-node-exporter:
+ enabled: true
+ # grafana
+ grafana:
+ enabled: true
```
#### Docker images
diff --git a/versioned_docs/version-3.1.x/helm-deploy.md
b/versioned_docs/version-3.1.x/helm-deploy.md
index 81d5c9ac6361..1236ce2551df 100644
--- a/versioned_docs/version-3.1.x/helm-deploy.md
+++ b/versioned_docs/version-3.1.x/helm-deploy.md
@@ -103,15 +103,27 @@ components:
toolset: true
# pulsar manager
pulsar_manager: true
+```
+
+##### Monitoring Components
+The Pulsar Helm Chart installs monitoring components using a dependent Helm
chart,
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts).
You can customize this Helm chart to specify which monitoring components to
install. These components are enabled by default.
+
+```yaml
## Monitoring Components
##
-## Control what components of the monitoring stack to deploy for the cluster
-monitoring:
- # monitoring - prometheus
- prometheus: true
- # monitoring - grafana
- grafana: true
+## Control what components of the kube-prometheus-stack Helm chart to deploy
for the cluster
+kube-prometheus-stack:
+ # Control deployment of this Helm chart entirely
+ enabled: true
+ # prometheus
+ prometheus:
+ enabled: true
+ promtheus-node-exporter:
+ enabled: true
+ # grafana
+ grafana:
+ enabled: true
```
#### Docker images
diff --git a/versioned_docs/version-3.2.x/helm-deploy.md
b/versioned_docs/version-3.2.x/helm-deploy.md
index 04b46e659d63..25d45219ab64 100644
--- a/versioned_docs/version-3.2.x/helm-deploy.md
+++ b/versioned_docs/version-3.2.x/helm-deploy.md
@@ -100,15 +100,27 @@ components:
toolset: true
# pulsar manager
pulsar_manager: true
+```
+
+##### Monitoring Components
+The Pulsar Helm Chart installs monitoring components using a dependent Helm
chart,
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts).
You can customize this Helm chart to specify which monitoring components to
install. These components are enabled by default.
+
+```yaml
## Monitoring Components
##
-## Control what components of the monitoring stack to deploy for the cluster
-monitoring:
- # monitoring - prometheus
- prometheus: true
- # monitoring - grafana
- grafana: true
+## Control what components of the kube-prometheus-stack Helm chart to deploy
for the cluster
+kube-prometheus-stack:
+ # Control deployment of this Helm chart entirely
+ enabled: true
+ # prometheus
+ prometheus:
+ enabled: true
+ promtheus-node-exporter:
+ enabled: true
+ # grafana
+ grafana:
+ enabled: true
```
#### Docker images
diff --git a/versioned_docs/version-3.3.x/helm-deploy.md
b/versioned_docs/version-3.3.x/helm-deploy.md
index 04b46e659d63..25d45219ab64 100644
--- a/versioned_docs/version-3.3.x/helm-deploy.md
+++ b/versioned_docs/version-3.3.x/helm-deploy.md
@@ -100,15 +100,27 @@ components:
toolset: true
# pulsar manager
pulsar_manager: true
+```
+
+##### Monitoring Components
+The Pulsar Helm Chart installs monitoring components using a dependent Helm
chart,
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts).
You can customize this Helm chart to specify which monitoring components to
install. These components are enabled by default.
+
+```yaml
## Monitoring Components
##
-## Control what components of the monitoring stack to deploy for the cluster
-monitoring:
- # monitoring - prometheus
- prometheus: true
- # monitoring - grafana
- grafana: true
+## Control what components of the kube-prometheus-stack Helm chart to deploy
for the cluster
+kube-prometheus-stack:
+ # Control deployment of this Helm chart entirely
+ enabled: true
+ # prometheus
+ prometheus:
+ enabled: true
+ promtheus-node-exporter:
+ enabled: true
+ # grafana
+ grafana:
+ enabled: true
```
#### Docker images
