Skip to main content

Getting Started Guide

This guide will help you get up and running with the StarTree Community Edition on a local Kubernetes environment in a few minutes. For running it in AWS, visit Link

info

For differences between StarTree ThirdEye Community Edition vs Enterprise Edition, visit: Link

Watch this video to learn how to install StarTree Community Edition

Prerequisites for installing StarTree Community Edition

Getting the Helm Repo

Required Tools

info

You can skip this section if you have Docker, minikube, and helm installed on your machine.

Install Docker / Docker Desktop

Follow the instructions on the Docker Website to install Docker on your machine.

Please ensure that Docker Desktop (or Docker Daemon) is running after you install it.

caution

If you are using Docker Desktop on Mac or Windows, please allow at least 10G of memory and 4 CPU cores. For better performance and memory our recommendation is to install it in AWS EC2 instance (t2.xlarge)

Install Helm

Follow the instructions on the Helm Website to install the helm CLI tool.

Install Minikube

We recommend using Minikube to set up a local Kubernetes cluster. Follow the instructions on the Minikube Website to install it.

caution

If you have a minikube cluster already running. We recommend you delete it and create a new cluster with more resources allocated. You can delete an existing minikube cluster with minikube delete

create a minikube cluster by running

minikube start --driver=docker --vm=true --cpus=4 --memory=10g --disk-size=20g --kubernetes-version=v1.21.7

Preload Images (Apple M1/M2 Macbooks only)

Please skip this step if you are not on an M1 or M2 Macbook.

Run the following commands to prevent runtime issues on Apple Silicon and Docker

eval $(minikube docker-env)
docker pull --platform linux/x86_64 mysql:8.0.28
docker pull --platform linux/x86_64 adoptopenjdk/openjdk11:alpine
docker pull --platform linux/x86_64 apachepinot/pinot:latest-jdk11
docker pull --platform linux/x86_64 bitnami/zookeeper:3.7.0-debian-10-r56

Install StarTree Community Edition

If you followed the guide to Getting the Helm Repo, you should have received an email with the links to the Helm repo/chart.

Install the Helm Repo

helm repo add startree <REPO LINK FROM EMAIL>
helm install startree startree/startree-community-edition

Wait for all the pods to have a status of Running and have all their containers READY. The state transition can take about 3-5 minutes.

Before proceeding, ensure that the Status of all Pinot components are marked as Alive on the Pinot Controller UI.

You can access the Pinot Controller UI by port-forwarding port 9000 on the pod. Run the following command and visit http://localhost:9000/ on your browser.

kubectl port-forward svc/startree-pinot-controller 9000:9000

Running queries in Pinot Query Console for the Sample Data

image

Try StarTree ThirdEye (Community Edition) with sample datasets

Follow the steps listed here to get started with exploring sample dataset and alerts in StarTree ThirdEye(Community Edition).