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

Document best practices for editing dashboards in grafrana while the operator is active #1597

Open
gberche-orange opened this issue Jun 28, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@gberche-orange
Copy link

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

When the operator is reconciling (version 5.8.1, packaged by bitnami helm chart 4.1.0), it is overriding changes made to dashboards using grafana ui.

(If applicable)If your feature request solves a bug please provide a link to the community issue

Describe the solution you'd like

A documented workflow on how to author dashboards using the UI while working with grafana operator

Here is the workflow what I'm currently using, but it is tedious and error prone

Initial version of a dashboard:

  • author a new dashboard in grafana UI (ignored by operator as it is not declared)
  • export the modified dashboard as json (button share, and export tag and Export for sharing externally)
  • update the expected state by operator (say configmap pulled from git repo)

2nd version of the dashboard:

  • make a copy of the dashboard to modify it (named dashboard-copy)
  • edit the dashboard-copy
  • export the dashboard-copy as json
  • edit the Json to:
    • restore original name
    • restore original dashboard gui
  • update the expected state by operator (say configmap pulled from git repo)

Describe alternatives you've considered

Checking dashboard CRD api for existing undocumented support for pausing the reconciliation during authoring of new dashboards (similar to flux suspend/resume)

The operator could also detects drifts (i.e. newer versions) and only issue a warning without overriding the dashboard. Potentially related to #1106

Additional context
Add any other context or screenshots about the feature request here.

Existing solutions
If applicable please provide a link to an existing solution from a different project

@gberche-orange gberche-orange added enhancement New feature or request needs triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 28, 2024
@NissesSenap NissesSenap 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 Jul 1, 2024
@theSuess theSuess added the good first issue Good for newcomers label Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

3 participants