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

GrafanaDashboard folder handling #1514

Closed
marcantoine-bibeau opened this issue May 1, 2024 · 5 comments
Closed

GrafanaDashboard folder handling #1514

marcantoine-bibeau opened this issue May 1, 2024 · 5 comments
Labels
bug Something isn't working triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@marcantoine-bibeau
Copy link

Describe the bug
GrafanaDashboard currently have a spec.folder that is the folder name to be used or created. It does NOT "connect" to the GrafanaFolder CR

Version
v5.8.1

To Reproduce

  • Create a new GrafanaDashboard with a "folder name" when there's NO GrafanaFolder
  • Dashboard is created inside a new "folder name" Folder

Expected behavior
It should follow the same strategy that GrafanaAlertRuleGroup follow using the folderRef instead.
Otherwise GrafanaAlertRuleGroup should follow GrafanaDashboard folder strategy

Runtime (please complete the following information):

  • OS: Linux
  • Grafana Operator Version v5.8.1
  • Environment: Kubernetes
  • Deployment type: running the operator on Kubernetes with Grafana Cloud
@marcantoine-bibeau marcantoine-bibeau added bug Something isn't working needs triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 1, 2024
@theSuess theSuess added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 6, 2024
@theSuess
Copy link
Member

theSuess commented May 6, 2024

Thanks for pointing this out. We'll deprecate the folder field of the GrafanaDashboard resource and introduce the same fields as in GrafanaAlertRuleGroup (folderRef and folderUID).

Removing the folder field entirely though is not something we can easily do without breaking changes. Since we had some other breaking changes proposed now, we have opened a new milestone for promoting the CRD from v1betav1 to v1. I've added this issue to that list now.

@ahmada-liatrio
Copy link

I think that there's some flexibility to be gained having the GrafanaAlertRuleGroup use the GrafanaDashboard folder strategy instead of FolderRef. Makes it easier to use existing folders that may not be captured in code through the operator.

I definitely think there should be a standard strategy they both default to.

@mangkoran
Copy link

I also encountered related issue. When I tried to use folderRef in GrafanaDashboard, I got error .spec.folderRef: field not declared in schema. I'm on grafana-operator v5.8.1. CMIIW if this has been fixed in recent version.

@theSuess
Copy link
Member

@mangkoran if using helm to install the operator, you'll need to perform additonal steps to also update the resource definitions: https://grafana.github.io/grafana-operator/docs/installation/helm/#upgrading

@theSuess
Copy link
Member

The issue in general has been resolved through #1601

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

4 participants