Official Helm Chart for Apache Pulsar and StreamNative Platform

This is the officially supported Helm Chart for install Apache Pulsar or StreamNative Platform on Kubernetes.

This Helm Chart includes all the components of Apache Pulsar for a complete experience.

It includes support for:

Requirements

In order to use this chart to deploy Apache Pulsar on Kubernetes, the followings are required.

kubectl 1.14 or higher, compatible with your cluster (+/- 1 minor release from your cluster)
Helm v3 (3.0.2 or higher)
A Kubernetes cluster, version 1.14 or higher.

Environment setup

Before proceeding to deploying Pulsar, you need to prepare your environment.

Tools

helm and kubectl need to be installed on your computer.

Add to local Helm repository

To add this chart to your local Helm repository:

helm repo add streamnative https://charts.streamnative.io

To use the helm chart:

NOTE: Please specify --set initialize=true when installing a release at the first time. initialize=true will start initialize jobs to initialize the cluster metadata for both bookkeeper and pulsar clusters.

helm install --set initialize=true <release-name> streamnative/pulsar

Kubernetes cluster preparation

You need a Kubernetes cluster whose version is 1.14 or higher in order to use this chart, due to the usage of certain Kubernetes features.

We provide some instructions to guide you through the preparation for the following cloud providers.

Google Kubernetes Engine
Amazon EKS
Azure Container Service
OpenShift Origin
On-Premises solutions

Deploy Pulsar to Kubernetes

Clone the StreamNative Helm charts repository.

git clone https://github.com/streamnative/charts.git

cd charts

Run prepare_helm_release.sh to create required kubernetes resources for installing this Helm chart.
- A k8s namespace for installing the Pulsar release (if -c is specified)
- Create the JWT secret keys and tokens for three superusers: broker-admin, proxy-admin, and admin. By default, it generates asymmeric pubic/private key pair. You can choose to generate symmeric secret key by specifying --symmetric in the following command.
  - proxy-admin role is used for proxies to communicate to brokers.
  - broker-admin role is used for inter-broker communications.
  - admin role is used by the admin tools.
```
./scripts/pulsar/prepare_helm_release.sh -n <k8s-namespace> -k <pulsar-release-name> -c
```

Add loki Helm Charts repository and update charts.

$ helm repo add loki https://grafana.github.io/loki/charts
$ helm dependency update pulsar

Use the Pulsar Helm charts to install StreamNative Platform.

NOTE: Please specify --set initialize=true when installing a release at the first time. initialize=true will start initialize jobs to initialize the cluster metadata for both bookkeeper and pulsar clusters.

This command installs and starts StreamNative Platform.

```bash 
$ helm install --set initialize=true <pulsar-release-name> streamnative/pulsar
```

Access the Pulsar cluster

The default values will create a ClusterIP for the proxy you can use to interact with the cluster. To find the IP address of proxy use:
```
kubectl get service -n <k8s-namespace>
```

For more information, please follow our detailed quick start guide.

Customize the deployment

We provide a detailed guideline for you to customize the Helm Chart for a production-ready deployment.

You can also checkout out the example values file for different deployments.

Upgrading

Once your Pulsar Chart is installed, configuration changes and chart updates should be done using helm upgrade.

If you are updating images used by the Helm chart, you can specify imagePuller.hook.enabled to enable a Helm hook to pull images before deploying a newer Helm release. The imagePuller ensures all the images are pulled to all kubernetes hosts before deploying the Helm release.

helm repo add streamnative https://charts.streamnative.io/
helm repo update
helm get values <pulsar-release-name> > pulsar.yaml
helm upgrade -f pulsar.yaml \
    [--set imagePuller.hook.enabled=true] \
    <pulsar-release-name> streamnative/pulsar

For more detailed information, see our Upgrading guide.

Uninstall

To uninstall the Pulsar Chart, run the following command:

helm delete <pulsar-release-name>

For the purposes of continuity, these charts have some Kubernetes objects that are not removed when performing helm delete. These items we require you to conciously remove them, as they affect re-deployment should you choose to.

PVCs for stateful data, which you must consciously remove
- ZooKeeper: This is your metadata.
- BookKeeper: This is your data.
- Prometheus: This is your metrics data, which can be safely removed.
Secrets, if generated by our prepare release script. They contain secret keys, tokens, etc. You can use cleanup release script to remove these secrets and tokens as needed.

Troubleshooting

We've done our best to make these charts as seamless as possible, occasionally troubles do surface outside of our control. We've collected tips and tricks for troubleshooting common issues. Please examine these first before raising an issue, and feel free to add to them by raising a Pull Request!

Please visit StreamNative Docs for more details.

MisterTimn/charts-1