Alauda Container Platform

Migrate MonitorDashboard to Perses

TOC

OverviewPrerequisitesMigrate a DashboardConversion RulesImport Grafana JSONAfter MigrationRelated Operations

Overview

Starting from Alauda Container Platform 4.4, Perses monitoring dashboards are available alongside the existing MonitorDashboard capability. You can migrate existing MonitorDashboard resources to PersesDashboard resources and render them from Operations Center > Monitor > Dashboards (Perses).

The migration converts the Grafana-style MonitorDashboard model to the PersesDashboard model. The source MonitorDashboard is retained and remains available from the existing monitoring dashboard entry.

Migration is selective. You choose the MonitorDashboard resources to migrate and trigger the conversion by adding a migration label with kubectl.

Prerequisites

Before migrating dashboards, make sure the following requirements are met:

  • The target cluster has installed Alauda Container Platform Dashboard for Perses.
  • The global cluster has installed Alauda Container Platform Dashboard Essentials.
  • You have read permission for the source MonitorDashboard resources.
  • You have create or write permission for the target PersesDashboard resources.

For component installation, see Installation.

Migrate a Dashboard

Migration is triggered by adding the cpaas.io/migrate-to-perses=true label to a MonitorDashboard resource.

  1. List MonitorDashboard resources and identify the dashboard that you want to migrate.

    kubectl get monitordashboards.ait.alauda.io -A

  2. Add the migration label to the MonitorDashboard resource.

    kubectl label monitordashboards.ait.alauda.io <name> -n <namespace> cpaas.io/migrate-to-perses=true

  3. Verify that the PersesDashboard resource is generated.

    The generated PersesDashboard is named <source-monitor-dashboard-name>-pd.

    kubectl get persesdashboards.perses.dev <name>-pd -n <namespace>

  4. In the console, go to Operations Center > Monitor > Dashboards (Perses) and verify that the migrated dashboard is listed and can be opened.

INFO
  • To migrate multiple dashboards, run the label command for each dashboard. You can migrate dashboards in batches.
  • Migration does not delete or modify the source MonitorDashboard. The original dashboard and entry remain available.
  • The user running the command must have permission to read MonitorDashboard resources and write PersesDashboard resources.

Conversion Rules

The migration tool converts MonitorDashboard content to the PersesDashboard model.

Conversion itemDescription
Chart typesGrafana-style chart types are mapped to Perses chart types, such as Time Series Chart, Stat Chart, Gauge Chart, Bar Chart, Pie Chart, and Table. Unsupported chart types are retained as placeholder Markdown panels.
QueriesQueries are rewritten to use the platform metric query gateway observe-api. The dashboard does not expose data source selection.
Display name and metadataThe display name, description, tags, and folder information are carried over when available.
Instant queriesInstant-value queries are converted to ACP Courier Instant Query.

Import Grafana JSON

If you have Grafana dashboard JSON instead of a MonitorDashboard resource, you can import it from Perses Monitoring Dashboards. Open the Create drop-down menu, select Import dashboard, and provide the JSON content.

Grafana JSON import uses a lossy Grafana-to-Perses conversion. Only chart types and functions supported by the current platform version are preserved.

After Migration

  • The generated Perses dashboard is an editable custom dashboard.
  • The source MonitorDashboard remains available from the existing monitoring dashboard entry.
  • If a source dashboard does not contain the cpaas.io/display-name annotation, the migrated dashboard may show the Kubernetes resource name in the Perses dashboard list. This does not affect rendering or metric queries.