-
-
Notifications
You must be signed in to change notification settings - Fork 281
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
chore: add script to pull dashboards from remote API #5525
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dapplion
changed the title
Add script to pull dashboards from remote API
chore: add script to pull dashboards from remote API
May 24, 2023
Opened a second PR with only dashboard diff to allow easier review of the download scripts here #5526 |
Performance Report✔️ no performance regression detected Full benchmark results
|
dapplion
force-pushed
the
dapplion/download-dashboards
branch
from
May 24, 2023 09:55
bee9d04
to
06d9c40
Compare
wemeetagain
approved these changes
May 24, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
amazing, love this
Might wanna update CONTRIBUTING.md to reflect new workflow in another PR. |
This was referenced May 30, 2023
🎉 This PR is included in v1.9.0 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Our DX to update dashboards is not good, since it requires to manually download files and perform some changes to minimize diff. We want to promote faster experimentation with dashboards to ensure they are up to date and persisted in git.
Download script
With one command run it lists all dashboards in the API, downloads then, cleans them up ready to be commited. This allows to very fast iteration of dashboards:
To use the script:
Create a file
.secrets.env
with envsRun
Check git diff of resulting files, commit, push and open PR
New linter rules
To ensure the download command is deterministic we need more linter rules. Using the HTTP API does not allow to set "Export for sharing externally" to true. So the fields starting with
__
must be set manually, see https://community.grafana.com/t/export-dashboard-for-external-use-via-http-api/50716