Skip to content

Quickstart

Ten minutes from an empty org to a dashboard on your phone. You need a Kubernetes cluster with Prometheus already scraping it, Helm 3, and the iOS app, which is on TestFlight while it is in beta.

Sign in at admin.vedavid.dev with your work email. A six-digit code arrives by email; type it in. There is no password. The first person from a domain registers the company and becomes its admin; colleagues sign in the same way and join under the rule the admin sets, straight in or after approval.

On the Connectors page, enrol a connector for the cluster you are about to connect. The token is shown once. Save it to a file rather than your clipboard, since the next step reads it from disk. Tokens are one connector each and can be revoked or rotated from the same page.

The connector is one open-source Rust binary that runs next to Prometheus. It dials out to the relay, holds that connection open, and answers queries over it. It listens on no port and holds no Kubernetes permissions: the chart ships no RBAC and the pod has no service account token.

shell
kubectl create namespace vedavid
kubectl --namespace vedavid create secret generic vedavid-enrolment-token \
--from-file=token=./enrolment-token.txt
helm install vedavid oci://ghcr.io/vedavid-dev/charts/vedavid-connector \
--namespace vedavid \
--set clusterLabel=prod-eu \
--set prometheus.url=http://prometheus-server.monitoring.svc.cluster.local

clusterLabel is what the app shows beside each dashboard, so a tenant with several clusters can tell them apart. prometheus.url is the in-cluster address of your Prometheus; the default matches the community prometheus chart in a monitoring namespace.

The pod exchanges the token for a client certificate, then opens the tunnel:

shell
kubectl --namespace vedavid logs deploy/vedavid-vedavid-connector | tail -2
INFO enrolled
INFO tunnel established, serving queries

The Connectors page in the console shows the same thing, with the last heartbeat and the certificate’s expiry.

Dashboards are YAML files in a ConfigMap, projected into the connector as files. The chart mounts every ConfigMap named in dashboards.sources; the default is one map called vedavid-dashboards.

The quickest start is a directory from the dashboard library, which builds a ready-made ConfigMap. This one needs only kube-state-metrics and node-exporter:

shell
kubectl apply -k "https://github.com/vedavid-dev/dashboards//k8s?ref=v0.1.0"
helm upgrade vedavid oci://ghcr.io/vedavid-dev/charts/vedavid-connector \
--namespace vedavid --reuse-values \
--set 'dashboards.sources[0].configMap=vedavid-dashboards-k8s'

Your own dashboards go the same way. Write the file, generate the ConfigMap, and keep the name fixed so it matches what the chart mounts:

dashboards/gateway-edge.yaml
version: 1
id: gateway-edge
title: Gateway edge
elements:
- type: stat
title: Requests per second
query: sum(rate(http_requests_total{job="gateway-edge"}[5m]))
unit: requests_per_sec
- type: stat
title: Error rate
query: 100 * sum(rate(http_requests_total{job="gateway-edge",code=~"5.."}[5m])) / sum(rate(http_requests_total{job="gateway-edge"}[5m]))
unit: percent
thresholds:
direction: above
steps:
- { at: 1, level: warning }
- { at: 5, level: critical }
kustomization.yaml
namespace: vedavid
generatorOptions:
disableNameSuffixHash: true
configMapGenerator:
- name: vedavid-dashboards
files:
- dashboards/gateway-edge.yaml

Check a file before committing it with the dashboard compiler: vedavid-dash lint dashboards/. The connector rescans its directory every thirty seconds, so a merged change reaches the app on its next refresh. The dashboard schema lists every field.

Sign in with the same email and the code that arrives. Your organisation’s clusters and dashboards appear straight away. If a panel is empty, the query returned nothing; the app does not invent zeroes.

To look around before your cluster is connected, sign in with a Gmail address: it lands in the demo organisation, which runs the library’s dashboards against a real cluster. If your company is not registered yet, the app says so and offers both routes.