Update Helm Chart Documentation (#6725)
*Motivation* The current helm chart is lacking documentation. This pull request aims to add documentation. *Changes* - Update Helm chart documentation - Add a get-started section with Helm chart - Remove the documentation of using yaml files.
This commit is contained in:
parent
f64c396906
commit
9e540ab791
56
README.md
56
README.md
@ -19,58 +19,4 @@
|
||||
|
||||
-->
|
||||
|
||||
This directory contains the Helm Chart required
|
||||
to do a complete Pulsar deployment on Kubernetes.
|
||||
|
||||
## Install Helm
|
||||
|
||||
Before you start, you need to install helm.
|
||||
Following [helm documentation](https://docs.helm.sh/using_helm/#installing-helm) to install it.
|
||||
|
||||
## Deploy Pulsar
|
||||
|
||||
### Minikube
|
||||
|
||||
#### Install Minikube
|
||||
|
||||
[Install and configure minikube](https://github.com/kubernetes/minikube#installation) with
|
||||
a [VM driver](https://github.com/kubernetes/minikube#requirements), e.g. `kvm2` on Linux
|
||||
or `hyperkit` or `VirtualBox` on macOS.
|
||||
|
||||
#### Create a K8S cluster on Minikube
|
||||
|
||||
```
|
||||
minikube start --memory=8192 --cpus=4
|
||||
```
|
||||
|
||||
#### Set kubectl to use Minikube.
|
||||
|
||||
```
|
||||
kubectl config use-context minikube
|
||||
```
|
||||
|
||||
After you created a K8S cluster on Minikube, you can access its dashboard via following command:
|
||||
|
||||
```
|
||||
minikube dashboard
|
||||
```
|
||||
|
||||
The command will automatically trigger open a webpage in your browser.
|
||||
|
||||
#### Install Pulsar Chart
|
||||
|
||||
Assume you already cloned pulsar repo in `PULSAR_HOME` directory.
|
||||
|
||||
1. Go to Pulsar helm chart directory
|
||||
```shell
|
||||
cd ${PULSAR_HOME}/deployment/kubernetes/helm
|
||||
```
|
||||
1. Install helm chart.
|
||||
```shell
|
||||
helm install --values pulsar/values-mini.yaml ./pulsar
|
||||
```
|
||||
|
||||
Once the helm chart is completed on installation, you can access the cluster via:
|
||||
|
||||
- Web service url: `http://$(minikube ip):30001/`
|
||||
- Pulsar service url: `pulsar://$(minikube ip):30002/`
|
||||
Read [Deploying Pulsar on Kubernetes](http://pulsar.apache.org/docs/en/deploy-kubernetes/) for more details.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user