Getting Started

Install the TapTally backend and frontend charts on your cluster.

Prerequisites

Kubernetes 1.19+
Helm 3.0+
A reachable PostgreSQL database
An S3-compatible object store (AWS S3, MinIO, …)
(Optional) Gateway API CRDs if you plan to expose services via HTTPRoute

1. Get the charts

Clone the repository, which contains both Helm charts under helm/:

git clone https://github.com/jevjay/taptally.git
cd taptally

2. Install the backend

helm install taptally-backend ./helm/taptally-backend

Override values inline for a quick start:

helm install taptally-backend ./helm/taptally-backend \
  --set image.tag=v1.0.0 \
  --set config.postgres_host=postgresql.default.svc.cluster.local \
  --set secrets.postgres_password=supersecure

Or supply a values file (recommended for anything beyond a trial):

helm install taptally-backend ./helm/taptally-backend -f my-values.yaml

3. Install the frontend

helm install taptally-frontend ./helm/taptally-frontend

4. Verify

kubectl get pods -l app.kubernetes.io/name=taptally-backend
kubectl logs -l app.kubernetes.io/name=taptally-backend --tail=100 -f

Upgrading

Adjust your values file, then:

helm upgrade taptally-backend ./helm/taptally-backend -f my-values.yaml
helm upgrade taptally-frontend ./helm/taptally-frontend -f my-values.yaml

Uninstalling

helm uninstall taptally-backend
helm uninstall taptally-frontend

Next steps

Tune settings in Configuration.
Turn on nginx/traefik request tallies in the Log Collector guide.

Image tags for both components are published on Docker Hub: backend · frontend.

Found an issue in the docs? Open an issue on GitHub.