Skip to main content

Apache Pulsar Helm Chart

Helm chart supports you to install Apache Pulsar in a cloud-native environment.

Introduction​

The Apache Pulsar Helm chart provides one of the most convenient ways to operate Pulsar on Kubernetes. With all the required components, Helm chart is scalable and thus being suitable for large-scale deployments.

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

Moreover, Helm chart supports:

  • Security
    • Automatically provisioned TLS certificates, using Jetstack's cert-manager
    • TLS Encryption
      • Proxy
      • Broker
      • Toolset
      • Bookie
      • ZooKeeper
    • Authentication
      • JWT
    • Authorization
  • Storage
    • Non-persistence storage
    • Persistent volume
    • Local persistent volumes
  • Functions
    • Kubernetes Runtime
    • Process Runtime
    • Thread Runtime
  • Operations
    • Independent image versions for all components, enabling controlled upgrades

Quick start​

To run with Apache Pulsar Helm chart as fast as possible in a non-production use case, we provide a quick start guide for Proof of Concept (PoC) deployments.

This guide walks you through deploying Apache Pulsar Helm chart with default values and features, but it is not suitable for deployments in production-ready environments. To deploy the charts in production under sustained load, you can follow the complete Installation Guide.

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, and feel free to add your solutions by creating a Pull Request.

Installation​

The Apache Pulsar Helm chart contains all required dependencies.

If you deploy a PoC for testing, we strongly suggest you follow this Quick Start Guide for your first iteration.

  1. Preparation
  2. Deployment

Upgrading​

Once the Apache Pulsar Helm chart is installed, you can use helm upgrade command to configure and update it.


helm repo add apache https://pulsar.apache.org/charts
helm repo update
helm get values <pulsar-release-name> > pulsar.yaml
helm upgrade <pulsar-release-name> apache/pulsar -f pulsar.yaml

For more detailed information, see Upgrading.

Uninstallation​

To uninstall the Apache Pulsar Helm chart, run the following command:


helm delete <pulsar-release-name>

For the purposes of continuity, some Kubernetes objects in these charts cannot be removed by helm delete command. It is recommended to consciously remove these items, as they affect re-deployment.

  • PVCs for stateful data: remove these items.
    • ZooKeeper: This is your metadata.
    • BookKeeper: This is your data.
    • Prometheus: This is your metrics data, which can be safely removed.
  • Secrets: if the secrets are generated by the prepare release script, they contain secret keys and tokens. You can use the cleanup release script to remove these secrets and tokens as needed.
Was this helpful?
💡 Suggest changes🛟 Get support