Skip to content

Feature Request: ConfigMap-based Dashboard Provisioning (Grafana-style sidecar) #170

@heiba

Description

@heiba

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:

  1. Watches a ConfigMap or a mounted volume for dashboard JSON files
  2. Automatically imports/updates dashboards in HyperDX via the API
  3. 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

Environment

  • Deployment: Kubernetes (RKE2)
  • Helm chart: clickstack/clickstack

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions