Skip to content

docs(grafana): document Classic file-export for --input-mode files #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shaurya2k06 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(grafana): document Classic file-export for --input-mode files #297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/sources/grafana.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,29 @@ Links, annotations, transformations, and legacy alert tasks are derived from
dashboard JSON during migration. They are not fetched as separate first-class
Grafana API assets in the current migration surface.

### File Export Scope

File-based dashboard migration uses `--source files` on the dedicated CLI and
`--input-mode files` on `obs-migrate migrate --source grafana`, with
`--input-dir` pointing at a directory of Grafana dashboard JSON exports.

From Grafana's Share → Export dialog, use the **default** export: Model =
**Classic**, format = **JSON**. You do not need to open Advanced options.
API-shaped exports (`{"dashboard": {...}, "meta": {...}}`) saved as `.json`
are also accepted.

Not supported today:
- Grafana V1 / V2 resource export models (`apiVersion` / `kind` / `metadata` /
`spec` wrappers)
- YAML exports

Those shapes are skipped by the extractor and surface as `no Grafana
dashboards found ... expected top-level 'panels' or 'rows' key`.

The "Share dashboard with another instance" / "Export for sharing externally"
toggles only replace datasource uid/name with placeholders in report metadata;
they do not change whether migration accepts the file.

## Execution Pipeline

The dedicated Grafana CLI is not just a translator. It is the most complete
Expand Down