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

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

Conversation

aboulay-numspot
Copy link
Contributor

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:

  • Use a folderRef field to target a folder deployed thanks to the GrafanaFolder CR.
  • Use a folderUID field to target an existing folder in Grafana.
  • Enable or disable folder creation from GrafanaDashboard by adding a field createFolder (default: true for retrocompatibility). This field cannot be false if folderUID and folderRef are not set in the GrafanaDashboard manifest.

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
Copy link

CLAassistant commented Jun 25, 2024

CLA assistant check
All committers have signed the CLA.

@aboulay-numspot aboulay-numspot changed the title docs: add grafana dashboard parent folder management docs: add proposal for grafana dashboard parent folder management Jun 26, 2024
@theSuess
Copy link
Member

theSuess commented Jul 1, 2024

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

@aboulay-numspot aboulay-numspot force-pushed the docs/add-grafana-dashboard-parent-folder-management branch 3 times, most recently from 766a7e7 to f17f88e Compare July 1, 2024 13:40
@aboulay-numspot
Copy link
Contributor Author

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. :)

@theSuess theSuess force-pushed the docs/add-grafana-dashboard-parent-folder-management branch from 57c91cd to bbf40f1 Compare July 4, 2024 08:02
@theSuess theSuess added this pull request to the merge queue Jul 4, 2024
@theSuess theSuess removed this pull request from the merge queue due to a manual request Jul 4, 2024
github-merge-queue bot pushed a commit that referenced this pull request Jul 4, 2024
…ard-parent-folder-management

docs: add proposal for grafana dashboard parent folder management
@theSuess theSuess force-pushed the docs/add-grafana-dashboard-parent-folder-management branch from 544abbd to 8a9c52c Compare July 8, 2024 09:11
@theSuess theSuess enabled auto-merge July 8, 2024 09:11
@theSuess theSuess added this pull request to the merge queue Jul 8, 2024
Merged via the queue into grafana:master with commit 4e49082 Jul 8, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants