Last modified July 8, 2025

Dashboard Creation

Creating custom dashboards lets you visualize your observability data exactly how your team needs it. The platform supports two main approaches: a GitOps workflow for production environments and interactive creation for rapid development and prototyping.

GitOps approach

The GitOps approach stores dashboard definitions as code, making them versionable, reviewable, and automatically deployable across environments. This is the recommended method for production dashboards.

Create a dashboard ConfigMap

Deploy dashboards by creating Kubernetes ConfigMaps in your management cluster:

apiVersion: v1
kind: ConfigMap
metadata:
  name: my-application-dashboard
  namespace: my-team-namespace
  labels:
    app.giantswarm.io/kind: dashboard
  annotations:
    observability.giantswarm.io/organization: MyTeam
data:
  dashboard.json: |
    {
      "dashboard": {
        "uid": "my-app-overview",
        "title": "My Application Overview",
        "tags": ["application", "performance"],
        "panels": [
          // Your dashboard panels here
        ]
      }
    }    

Organization targeting

The observability.giantswarm.io/organization annotation determines which Grafana organization receives the dashboard. The value must match an existing organization’s display name.

Dashboard requirements

  • Unique identifier (UID): Each dashboard needs a unique identifier within its organization
  • Valid JSON: Dashboard definitions must be valid Grafana JSON format
  • Proper labeling: Include the app.giantswarm.io/kind: dashboard label for automatic detection

Benefits of GitOps

  • Version control: Track changes and collaborate on dashboard improvements
  • Automated deployment: Dashboards deploy automatically when ConfigMaps are applied
  • Multi-environment support: Deploy the same dashboard across development, staging, and production
  • CI/CD integration: Include dashboard validation in your pipeline

Interactive creation

For rapid prototyping and iterative development, create dashboards directly in Grafana’s web interface.

Getting started

  1. Access your Grafana instance
  2. Navigate to Dashboards > New > New Dashboard
  3. Add panels, configure visualizations, and arrange your layout
  4. Save your dashboard to the appropriate organization

Grafana documentation

For detailed guidance on using Grafana’s dashboard builder, see the official Grafana documentation.

Data persistence

Dashboards created in the UI are stored in PostgreSQL with automatic backups, ensuring they persist across platform updates and restarts.

Best practices

Start with exploration

Before building dashboards, spend time in Grafana’s Explore view to understand your data and refine your queries.

Design for your audience

  • Executive dashboards: Focus on high-level KPIs and trends
  • Operational dashboards: Emphasize real-time status and alert states
  • Troubleshooting dashboards: Include detailed metrics and drill-down capabilities

Leverage existing resources

Next steps

This part of our documentation refers to our vintage product. The content may be not valid anymore for our current product. Please check our new documentation hub for the latest state of our docs.