-
Notifications
You must be signed in to change notification settings - Fork 35
Open
Description
Feature Request
Description
Add support for automatically provisioning dashboards from Kubernetes ConfigMaps, similar to Grafana's sidecar provisioner approach. This would enable GitOps workflows and Infrastructure-as-Code management of HyperDX dashboards.
Use Case
As a DevOps engineer managing ClickStack on Kubernetes, I want to:
- Store dashboard JSON files in Git alongside my infrastructure code
- Deploy dashboards declaratively via ConfigMaps or Helm values
- Automatically sync dashboard changes without manual UI interaction
- Maintain consistency across multiple environments (dev/staging/prod)
Proposed Solution
A sidecar container (or init container) that:
- Watches a ConfigMap or a mounted volume for dashboard JSON files
- Automatically imports/updates dashboards in HyperDX via the API
- Optionally supports annotations to control behavior (e.g., folder assignment, overwrite policy)
Example usage:
apiVersion: v1
kind: ConfigMap
metadata:
name: hyperdx-dashboards
labels:
hyperdx-dashboard: "true"
data:
k8s-overview.json: |
{ "name": "Kubernetes Overview", "charts": [...] }Alternatives Considered
- Manual import via UI (not scalable, not GitOps-friendly)
- Custom Job/CronJob calling the dashboard API (works but requires custom implementation per deployment)
- Direct MongoDB seeding (fragile, bypasses API validation)
References
- Grafana sidecar provisioner: https://github.com/grafana/helm-charts/tree/main/charts/grafana#sidecar-for-dashboards
- HyperDX Dashboard API: https://www.hyperdx.io/docs/api/dashboards
- Recent dashboard import/export feature (Sept 2025): https://clickhouse.com/blog/whats-new-in-clickstack-september-2025
Environment
- Deployment: Kubernetes (RKE2)
- Helm chart:
clickstack/clickstack
Metadata
Metadata
Assignees
Labels
No labels