Helm

Prerequisites: Kubernetes cluster, Pulsar (2.11 or newer), Kubectl, Helm
If you are using an older version of Pulsar, we provide special docker images - Please get in touch.

Quickstart

Install Streamvisor using the official helm chart:

# Setup helm repository
helm repo add streamvisor https://helm.streamvisor.com/
helm repo update
 
# Deploy helm chart
helm install streamvisor streamvisor/streamvisor -n pulsar

Configuration examples

To configure the Streamvisor deployment, you can override the helm chart default values by providing a custom values.yaml. To use your custom configuration, install the helm chart like this:

helm install streamvisor streamvisor/streamvisor -n pulsar --values values.yaml

Some examples of common examples are provided below:

Launching with custom admin user credentials

#values.yaml
secretCredentials:
  admin:
    email: custom@mydomain.org
    password: topsecret

Launching with a pre-created Pulsar environment

#values.yaml
config:
  STREAMVISOR_BOOTSTRAPENV_ENABLE: "true"
  STREAMVISOR_BOOTSTRAPENV_NAME: "development"
  STREAMVISOR_BOOTSTRAPENV_SERVICEURL: "http://pulsar-proxy:8080"
  STREAMVISOR_BOOTSTRAPENV_BROKERURL: "pulsar://pulsar-proxy:6650"

Enabling persistence

By default, persistence is disabled with persistence.enabled: false.
This option is for getting started and is not recommended for production setups.

To enable persistence, either let the helm chart provision a PersistentVolumeClaim for you:

#values.yaml
persistence:
  enabled: true
  annotations: {}
  accessModes:
    - ReadWriteOnce
  size: 1Gi
  storageClass:

or provide an existing PersistentVolumeClaim for Streamvisor to use:

#values.yaml
persistence:  
  enabled: true
  existingClaim: my-existing-pvc