From f4cb7a2c953515935360a78071a7d506a2bd3224 Mon Sep 17 00:00:00 2001 From: Michael Marshall Date: Thu, 20 Oct 2022 22:23:32 -0700 Subject: [PATCH] Simplify deployment instructions in README (#324) Fixes #287 ### Motivation The current steps to install the Apache Pulsar Helm Chart include an unnecessary script `scripts/pulsar/prepare_helm_release.sh`. It relies on tooling that has not been maintained and is not a part of the Apache Pulsar project. As such, I propose we remove these references. Note that one of the reasons we used these scripts historically is to simplify deployment. Without these scripts, we should document what is necessary. I am tracking that work here https://github.com/apache/pulsar-helm-chart/issues/323. --- README.md | 38 +++++--------------------------------- 1 file changed, 5 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 1b5f8f0..c257699 100644 --- a/README.md +++ b/README.md @@ -93,12 +93,6 @@ To add this chart to your local Helm repository: helm repo add apache https://pulsar.apache.org/charts ``` -To use the helm chart: - -```bash -helm install apache/pulsar -``` - ## Kubernetes cluster preparation 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. @@ -107,37 +101,15 @@ We provide some instructions to guide you through the preparation: http://pulsar ## Deploy Pulsar to Kubernetes -1. Clone the Pulsar Helm charts repository. +1. Configure your values file. The best way to know which values are available is to read the [values.yaml](./charts/pulsar/values.yaml). + +2. Install the chart: ```bash - git clone https://github.com/apache/pulsar-helm-chart - ``` - ```bash - cd pulsar-helm-chart + helm install -n -f your-values.yaml apache/pulsar ``` -2. 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 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. - - ```bash - ./scripts/pulsar/prepare_helm_release.sh -n -k -c - ``` - -3. Use the Pulsar Helm charts to install Apache Pulsar. - - This command installs and starts Apache Pulsar. - - ```bash - $ helm install apache/pulsar - ``` - -5. Access the Pulsar cluster +3. 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: