Skip to content

Conversation

@eero-t
Copy link
Collaborator

@eero-t eero-t commented Jul 4, 2025

Description

Editing Grafana dashboard JSON content directly from their configMaps is really awkward. It's much easier just to edit dashboard in Grafana, save the resulting JSON, use and the script(s) in this PR to convert it into a suitable configMap.

This adds conversion scripts for use with KubeAI and Helm dashboard chart. When used with Helm, there needs to be some additional (chart specific) changes for the configMaps and their contents, so these are separate scripts.

JSON files matching the current configMap contents are also included. That way they can be used also with Docker installs, and compared against corresponding dashboard JSON specs in the GenAIEval repository: https://github.com/opea-project/GenAIEval/tree/main/evals/benchmark/grafana

Issues

n/a.

Type of change

  • Enhancement (dashboard maintenance)

Dependencies

n/a.

Tests

Manually tested that using the scripts with the included JSON files produces (nearly) identical configMap files.

@eero-t eero-t force-pushed the dashboard-sources branch 3 times, most recently from 382054c to 89b7094 Compare July 8, 2025 13:27
@eero-t
Copy link
Collaborator Author

eero-t commented Jul 8, 2025

READMEs are not intended really intended for end-user documentation (but for whomever maintains the dashboard configMaps), so I renamed them to *.txt to avoid that, and the annoying doc CI. This means that GitHub won't render their MarkDown formatting though.

Pre-ci mangles the Grafana dashboard JSON files. I think Grafana will still accept them as they're still valid JSON, but it means comparing them against updated Grafana JSON exports being much less useful.

@CICD-at-OPEA
Copy link
Collaborator

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

eero-t added 3 commits August 11, 2025 12:29
As doc CI would require separate PR in separate repo.

These document internal process for producing the final dashboard
configMaps, so they do not need to be in end-user documentation.

Signed-off-by: Eero Tamminen <[email protected]>
@eero-t eero-t force-pushed the dashboard-sources branch from 1595d20 to 31a1fb7 Compare August 11, 2025 09:29
@poussa poussa requested review from marquiz and removed request for lianhao, mkbhanda and yongfengdu August 14, 2025 14:25
@CICD-at-OPEA
Copy link
Collaborator

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@CICD-at-OPEA
Copy link
Collaborator

This PR was closed because it has been stalled for 7 days with no activity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants