grafana / grafana-operator

An operator for Grafana that installs and manages Grafana instances, Dashboards and Datasources through Kubernetes/OpenShift CRs
https://grafana.github.io/grafana-operator/
Apache License 2.0
863 stars 384 forks source link

docs: add proposal for grafana dashboard parent folder management #1592

Closed aboulay-numspot closed 2 months ago

aboulay-numspot commented 2 months ago

Aim of the merge request:

This MR aims to create a document to propose an evolution on the folder management related to the parent folder.

The suggested new features are:

Breaking change

There is no breaking change because it is just a proposal document. Nothing is implemented yet.

This should be discussed during a maintainer meeting.

CLAassistant commented 2 months ago

CLA assistant check
All committers have signed the CLA.

theSuess commented 2 months ago

Outcome from discussing this in our weekly:

we want to only add folderUid and folderRef fields. The createFolder fields is implicitly defined through the presence of the new fields. This means:

Will clean up the proposal and we can further discuss this async

aboulay-numspot commented 2 months ago

Outcome from discussing this in our weekly:

we want to only add folderUid and folderRef fields. The createFolder fields is implicitly defined through the presence of the new fields. This means:

  • If folder is set and none of the other fields is set (backwards compat. case): Create the folder
  • If folderUID or folderRef is set, don't create the folder
  • If folderUID or folderRef AND folder is set, the new fields take priority -> don't create the folder

Will clean up the proposal and we can further discuss this async

@theSuess Normally, this should be fine now. I let you review a last time the document. :)