feat: Add a Dashboard for Monitoring the Operator Metrics

[Daniel-Vaz]

With this PR I'm adding the possibility to create a ConfigMap containing a Dashboard definition leveraging the operator metrics, based on a new set of Helm Values.

The new dashboard is based on this one.

Closes #653

@theSuess Could you please have a look ?
Feel free to mention any changes you see that could make sense.

[CLAassistant]

All committers have signed the CLA.

[NissesSenap]

It feels so wrong using a configmap for the grafana-operator when the whole point of the operator is to not use configmaps 😄

But I understand that we get a chicken and egg issue. we can't create grafana-operator CRDs as part of the helm chart.

But I do think we should document how to actually use this dashboard, with calling it from a CRD.
I would also suggest documentating that you can just use the url feature of the dashboard CRD, and point to https://grafana.com/grafana/dashboards/22785-grafana-operator/.

On the implementation side, I would suggest storing the pure json as a file, and call on it from helm: https://helm.sh/docs/chart_template_guide/accessing_files/#basic-example

This way you can easily copy and paste in new versions and it's a bit cleaner to read in my mind.

[theSuess]

+1 on the splitting up into a separate JSON file. That way we can also provide docs on how to include this dashboard using a remote reference for those who don't manage the operator using helm

[Daniel-Vaz]

@NissesSenap @theSuess

Thank you for your feedback!

I’ve updated the ConfigMap template to fetch the JSON definition from a dedicated file, as requested. I also enhanced the Values comments to include at least a mention of the Grafana.com URL and the dashboard ID.

Would you like me to add or modify an existing documentation page to cover the alternative method of deploying the Dashboard using an operator-managed CR? If so, which page in your opinion, would make the most sense for this to be mentioned in ?

[theSuess]

I think this could live on the same level as the installation guides with a title like Operations & Observability

Happy to hear out other suggestions though

[Daniel-Vaz]

Created a new docs page - https://github.com/grafana/grafana-operator/pull/1860/files#diff-4b689c46d14f73338965eb47866ddf89d63edea2083bc6a1a38faca1f88dec58

[theSuess]

The doc page looks good! The last thing I'd add here, is an example GrafanaDashboard referencing the deployed configmap for people using the helm option

[Daniel-Vaz]

The doc page looks good! The last thing I'd add here, is an example GrafanaDashboard referencing the deployed configmap for people using the helm option

Done 😄