Grafana dashboard w/ OBS packaging

[stefanotorresi]

This PR bundles the Grafana dashboards in this repository and introduce the OBS packaging to install those on top of Grafana.

SR to OBS devel upstream here: https://build.opensuse.org/request/show/815701

[arbulu89]

@stefanotorresi I'm a bit lost with the latest discussions and actually I didn't know that the plan was to add the dashboards here. Anyway, if this was the chosen thing It's totally fine for me.

Some comments:

• I miss some documentation in the main README saying that this projects stores grafana dashboards for this exporter. Mayne just add link from the main README to the dashboards README, and we can continue adding more data in the future. But it would be nice to know this when you enter to the project main documentation page.
• I see that requiring grafana in the spec file is logical, but this might create issues during the installation as grafana is provided by SUMA and not SLES4SAP. Just to have this in mind. I guess that this was already discussed and I lost the thread XD
• How is the versioning for the dashboards and the exporter? Do they use the same version? I cannot clearly understand this in the new code hehe If they use the same, we would have strange things like packages upgrading the version without any change, what most probably won't be liked by the packaging/maintenance teams

[arbulu89]

Is this required? I mean, to put some files in some folders during the build maybe grafana is not needed. If we can avoid it better hehe You know how the dependencies during the build time can be quite troubling

[stefanotorresi]

I initially tried to do without it, but we require the whole directory structure put in place by the Grafana package.
I guess I could duplicate some of the spec statements, but then what defines what package owns what path? Wouldn't we have conflicts?

[MalloZup]

I think is ok to require grafana, BuildRequires maybe we can spare it

[stefanotorresi]

the build will fail without that BuildRequire with the following error:

[   28s] grafana-ha-cluster-dashboards-1.0.0+git.1591970022.e33fbe9-1.1.noarch.rpm: directories not owned by a package:
[   28s]  - /etc/grafana
[   28s]  - /etc/grafana/provisioning
[   28s]  - /etc/grafana/provisioning/dashboards
[   28s]  - /var/lib/grafana
[   28s]  - /var/lib/grafana/dashboards

[arbulu89]

It would be nice to explain how to install the dashboards. A simple Installation chapter. We can add it in the future though

[stefanotorresi]

Yeah, this document is very much provisional, I even still have to decide if this should go in the project docs directory.

[MalloZup]

@stefanotorresi I would reference the dashboard in our top-level readme.

To install a grafana dashboard is pretty straightforward imho, we just say import the dashboard. and we can reference upstream.

But we need to make it visible on the top-level readme so an user know there is a dashboard

[stefanotorresi]

yep, I'm working on the docs right now!

[MalloZup]

do we need an additional package? maybe we can just include this 3 files on the exporter package without having another package to maintain.
What are the benifits of splitting it so small package?

[stefanotorresi]

do we need an additional package? maybe we can just include this 3 files on the exporter package without having another package to maintain.
What are the benifits of splitting it so small package?

we don't install the exporter and the dashboards in the same system! 🤪

[stefanotorresi]

@arbulu89

1. Yeah, the documentation surely needs improvements. I wanted to first experiment with the rpm, I will see to improve it at a later stage, along with the CI.
2. Yes, we require Grafana, which is provided by SUMA. This package wouldn't have any sense without Grafana installed. As long as Grafana will be delivered by SUMA, this package will only be available to customers buying bundled licenses of both SUMA and SLEHA.
3. For the time being the versioning scheme is handled manually by changing the _service file. The only automated part is the +git.%timestamp.%hash suffix. Versioning will always be separate, as each release and commit regarding the exporter doesn't necessarily mean an update of the dashboards. This will be handled by reworking the CI a bit, in another PR.

[MalloZup]

do we need the screenshot.png? it might be depracted dashboards/screenshot.png

[MalloZup]

what is used for the obs-workdir?

[stefanotorresi]

hmm?

[MalloZup]

I just forget the term

[stefanotorresi]

do we need the screenshot.png? it might be depracted dashboards/screenshot.png

yes, the plan is to show what the dashboard looks like in the markdown docs.

[arbulu89]

@stefanotorresi Thanks for adding the new info for the docs.
After this, at least from my side everything is really nice

[MalloZup]

lgtm to me