Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 5.12 KB

README.md

File metadata and controls

104 lines (73 loc) · 5.12 KB
Raw

RudderStack Helm Chart

RudderStack is a platform for collecting, storing and routing customer event data to dozens of tools.

TL;DR;

$ git clone [email protected]:rudderlabs/rudderstack-helm.git
$ cd rudderstack-helm/
$ helm install my-release ./ --set rudderWorkspaceToken="<workspace token from the dashboard>"

Introduction

This chart creates a Rudderstack deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

  • Kubectl installed and connected to your kubernetes cluster
  • Helm installed
  • Workspace token from the dashboard. Set up your account and copy your workspace token from the top of the home page.

Installing the Chart

To install the chart with the release name my-release, from the root directory of this repo:

$ helm install my-release ./ --set rudderWorkspaceToken="<workspace token from the dashboard>"

The command deploys Rudderstack on the default Kubernetes cluster configured with kubectl. The configuration section lists the most significant parameters that can be configured during deployment.

Upgrading the Chart

To update configuration or version of the images used, change the configuration and run:

$ helm upgrade my-release ./ --set rudderWorkspaceToken="<workspace token from the dashboard>"

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm uninstall my-release

This removes all the components created by this chart.

Open source Control Plane

If you are using open source config-generator UI, you need to set the parameter controlPlaneJSON to true in values.yaml file. Export workspace-config from the config-generator and copy/paste the contents into workspaceConfig.json file.

$ helm install my-release ./ --set backend.controlPlaneJSON=true

GCP

If you are using google cloud storage or google big query for following cases, you have to replace the contents of the file rudder-google-application-credentials.json with your service account.

  • GCS as a destination
  • GCS for dumping jobs
  • Big Query as a warehouse destination.

Configuration

The following table lists the configurable parameters of the Rudderstack chart and their default values.

Parameter Description Default
rudderWorkspaceToken Workspace token from the dashboard -
backend.image.repository Container image repository for the backend rudderlabs/rudder-server
backend.image.version Container image tag for the backend. Available versions v0.1.6
backend.image.pullPolicy Container image pull policy for the backend image Always
transformer.image.repository Container image repository for the transformer rudderlabs/transformer
transformer.image.version Container image tag for the transformer. Available versions v0.1.2
transformer.image.pullPolicy Container image pull policy for the transformer image Always
backend.extraEnvVars Extra environments variables to be used by the backend in the deployments Refer values.yaml file
backend.controlPlaneJSON If true, backend will read config from the workspaceConfig.json file false

Each of these parameters can be changed in values.yaml. Or specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set backend.image.version=v0.1.6 \
  ./

Note: Configuration specific to

  • Backend can be edited in rudder-config.toml.
  • Postgres can be edited in pg_hba.conf, postgresql.conf

Components

Installing this helm chart will deploy the following pods and containers in the configured cluster

POD - {Release name}-rudderstack-0 :

  • rudderstack-backend
  • rudderstack-telegraf-sidecar

POD - {Release name}-rudderstack-postgresql-0 :

  • {Release name}-rudderstack-postgresql

POD - {Release name}-rudderstack-transformer-xxxxxxxxxx-xxxxx:

  • transformer