Skip to content
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.

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

Links to Grafana dashboards from MetalK8s UI are broken #3475

Closed
2 tasks done
gdemonet opened this issue Aug 4, 2021 · 1 comment
Closed
2 tasks done

Links to Grafana dashboards from MetalK8s UI are broken #3475

gdemonet opened this issue Aug 4, 2021 · 1 comment
Assignees
Labels
kind:bug Something isn't working topic:monitoring Everything related to monitoring of services in a running cluster topic:ui UI-related issues

Comments

@gdemonet
Copy link
Contributor

gdemonet commented Aug 4, 2021

Component: grafana, ui

What happened:

In MetalK8s 2.10, we bumped Grafana to v8.x. However, this broke the links we were using from MetalK8s UI, which used the "by slug" URL format, which have been deprecated since Grafana v5.0.
In Grafana v8.0, this link format was removed entirely: https://grafana.com/docs/grafana/latest/release-notes/release-notes-8-0-0/#breaking-changes

Resolution proposal:

  • Deploy dashboards with well-known UIDs
  • Use UID-based links from MetalK8s UI
@gdemonet gdemonet added kind:bug Something isn't working topic:ui UI-related issues topic:monitoring Everything related to monitoring of services in a running cluster labels Aug 4, 2021
@gdemonet
Copy link
Contributor Author

gdemonet commented Aug 4, 2021

Relates to #2820 😕

@gdemonet gdemonet self-assigned this Aug 4, 2021
gdemonet added a commit that referenced this issue Aug 5, 2021
The dashboards we provision with MetalK8s have (or should have, which is
why some of this commit's changes are setting some UIDs) a UID. Starting
with Grafana v8.0, linking dashboards using their slug is not available
anymore (see
https://grafana.com/docs/grafana/latest/release-notes/release-notes-8-0-0/#breaking-changes
).

To make sure we can use these UIDs safely in links (mostly from MetalK8s
UI), we start by listing all of them in a JSON file, and enforce that
they are correct when rendering Helm charts.

Verifying the final deployed dashboards will be done in a subsequent
commit, through a post-install E2E test.

See: #3475
gdemonet added a commit that referenced this issue Aug 5, 2021
We add a test which compares the deployed Grafana dashboards with what
is declared in `charts/grafana_dashboard_uids.json`.

It will detect:
- missing and extra dashboards
- UID mismatches

This will ensure we can trust the listing in this file, and use it for
documenation and/or UI links.

See: #3475
@bert-e bert-e closed this as completed in fc0fa3b Aug 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:bug Something isn't working topic:monitoring Everything related to monitoring of services in a running cluster topic:ui UI-related issues
Projects
None yet
Development

No branches or pull requests

1 participant