feat: add GrafanaDashboard resource to Helm chart

[onedr0p]

This adds the ability to use a GrafanaDashboard from the https://github.com/grafana/grafana-operator

I tried to make this a non-breaking change for people already using the dashboard, but I really struggled to find a decent pattern I was happy with for that. I think that since this is such a low impact breaking change this is fine.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[phillebaba]

I am a big fan of Grafana Operator, and I think it is something we should offer. I have however been thinking about how we package and deliver Grafana dashboards. Would it make more sense to create a separate repository and Helm chart with the Grafana dashboard? That would allow separate work on the dashboard that is not tied to the project. Would also make cutting releases for the dashboard easier.

My other thought is that some people may not want to add the dashboard in every cluster, but only in their cluster that runs Grafana. Right now it is not possible to add just the charts without deploying Spegel.

Another option is to keep everything in the same repository but we create two Helm charts. Add a new chart for observability, like alertmanager rules and other nice things.

Happy for any feedback about this. Any thoughts about same repository vs. separate repository?

[nissessenap]

My 5 cents

For me it would be no impact as long as we have a seperation of alerts/dashboards from spegel it self.

It's probably easest to just put in a seperate repo and it's own helm chart.
The bad thing is of course that we probably want to have some compatibility matching between the spegel version and the monitoring helm chart.

Or keep it in the same repo, and have them match the current release flow which will slow down any alerts/dashboard updates.
Or update a bunch of release CI to support two different tags.

In general I'm anti mono-repo, so I would vote for it's own repo.

[onedr0p]

Would it make more sense to create a separate repository and Helm chart with the Grafana dashboard? That would allow separate work on the dashboard that is not tied to the project. Would also make cutting releases for the dashboard easier.

I don’t think that’s really necessary, especially for a project of this size. Most bigger projects like Cilium, Fluent Bit, VictoriaMetrics, and the Grafana Operator include their dashboards directly in the same Helm chart. That approach feels more standard and avoids the extra complexity of managing a separate repo just for observability.

My other thought is that some people may not want to add the dashboard in every cluster, but only in their cluster that runs Grafana. Right now it is not possible to add just the charts without deploying Spegel.

That’s actually already possible. Since the dashboard isn’t templated, users can just use the raw GitHub link directly. They can reference it in a GrafanaDashboard CR or include it with the Grafana Helm chart if they prefer. No need to deploy Spegel for that.