Quickstart
Three steps, under three minutes, from zero to a live cluster in the dashboard.
Prerequisites
- A Kubernetes cluster (≥ 1.26) with Helm ≥ 3.12
- Cluster-admin access (the agent lists / watches across namespaces)
- A free klstr workspace — sign up
Step 1 — Generate a registration token
In the dashboard, go to Settings → API Keys and click Generate registration key. You'll get a one-time token like:
k8s_reg_9a4f...e1b2The token is shown once. Copy it now — klstr never stores the raw value, only a SHA-256 hash.
Step 2 — Install the agent
The dashboard prints a ready-to-run Helm command with your token prefilled. It looks like this:
helm install klstr-agent https://app.klstr.dev/install/klstr-agent-chart.tgz \
--set agent.registrationToken="k8s_reg_9a4f...e1b2" \
--set agent.dashboardUrl="https://app.klstr.dev" \
--namespace klstr-agent \
--create-namespaceTwo pods spin up:
klstr-agent— the Bun runtime (64 Mi / 10 m requests)cloudflaredsidecar — opens a free Cloudflare Tunnel so klstr can reach the agent without opening inbound firewall rules on your side
Step 3 — Watch your cluster appear
Back in the dashboard, refresh Clusters. Within about 30 seconds:
- Your cluster shows up with live pod / deployment / service counts
- A green Connected badge appears
- Heartbeat shows less than 30 seconds ago
Open any pod. The drawer loads in under a second with metrics, events, logs, and YAML tabs all populated — that's your confirmation that everything is wired correctly.
Next steps
- Connect a second cluster — you can register up to 3 on the Free plan.
- Enable plug-ins. If Trivy, Kyverno, ArgoCD, etc. are installed in your cluster, klstr detects them automatically. Enable them at
/settings/plugins. - Upgrade to Pro for multi- cluster aggregated view and 5+ clusters.