commit | 7219a370653afed4e49316eacedc6177f045501f | [log] [tgz] |
---|---|---|
author | Lari Hotari <lhotari@users.noreply.github.com> | Wed Jan 12 12:45:58 2022 +0200 |
committer | GitHub <noreply@github.com> | Wed Jan 12 12:45:58 2022 +0200 |
tree | 2eec656c6f80e4b14c768162054be12e7ae67d3e | |
parent | ccf78f1c9dbcb850583fa967968e3d7a4a791d06 [diff] |
Fix chart releaser command which uses docker image (#199)
This is the officially supported Helm Chart for installing Apache Pulsar on Kubernetes.
Read Deploying Pulsar on Kubernetes for more details.
This Helm Chart includes all the components of Apache Pulsar for a complete experience.
It includes support for:
In order to use this chart to deploy Apache Pulsar on Kubernetes, the followings are required.
Before proceeding to deploying Pulsar, you need to prepare your environment.
helm
and kubectl
need to be installed on your computer.
To add this chart to your local Helm repository:
helm repo add apache https://pulsar.apache.org/charts
To use the helm chart:
helm install <release-name> apache/pulsar
You need a Kubernetes cluster whose version is 1.18 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: http://pulsar.apache.org/docs/en/helm-prepare/
Clone the Pulsar Helm charts repository.
git clone https://github.com/apache/pulsar-helm-chart
cd pulsar-helm-chart
Run prepare_helm_release.sh
to create required kubernetes resources for installing this Helm chart.
-c
is specified)broker-admin
, proxy-admin
, and admin
. By default, it generates asymmetric pubic/private key pair. You can choose to generate symmetric 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
Use the Pulsar Helm charts to install Apache Pulsar.
This command installs and starts Apache Pulsar.
$ helm install <pulsar-release-name> apache/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.
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.
Once your Pulsar Chart is installed, configuration changes and chart updates should be done using helm upgrade
.
helm repo add apache https://pulsar.apache.org/charts helm repo update helm get values <pulsar-release-name> > pulsar.yaml helm upgrade -f pulsar.yaml \ <pulsar-release-name> apache/pulsar
For more detailed information, see our Upgrading guide.
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.
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!
Bump the version in charts/pulsar/Chart.yaml.
Send a pull request for reviews.
After the pull request is approved, merge it. The release workflow will be triggered automatically.
pulsar-<version>
.charts/index.yaml
in Pulsar website.Trigger the Pulsar website build to make the release available under https://pulsar.apache.org/charts.