exported dashboards for sharing, created dashboard export script, upload dashboard github action and updated documentation

[ehearneRedHat]

What (currently completed):

• Exported dashboards for sharing publicly on Grafana site.
• Created a script for creating a universal dashboard with a "Export for sharing manually" exported dashboard.
• Added documentation on how to use script for creating a "universal" dashboard.
• Created GitHub Action that will upload any changes made to the universal dashboards when merged on main branch.

Verify (currently completed):

• Head over to https://grafana.com/grafana/dashboards/ and upload the changed files from this PR. They should all upload successfully, even as revisions. Feel free to delete afterwards.
• Run the quickstart script and expose the grafana service within the kuadrant-local cluster to port 3000:3000, login with credentials admin/admin and export the following dashboards, ensuring the toggle "Export for sharing manually" is toggled:
  • App Developer
  • Business User
  • Platform Engineer
• Follow the instructions in config/observability/README.md for running the script to create a universal dashboard. Test by importing into local Grafana instance, and uploading to Grafana Community Platform.

[david-martin]

I haven't attempted to upload any to grafana.com yet.
I have ran the quickstart locally to see how this version of the dashboards behave and I see a couple of errors related to the data source.

I wonder if there's a way to use the same exported version for both upload and import via configmap for our local environments.
If not, we may have to keep the source in the repo as it was before (not exported for sharing).
And use the option to export for sharing only when we need to update the latest dashboards in grafana.com

[ehearneRedHat]

I wonder if there's a way to use the same exported version for both upload and import via configmap for our local environments. If not, we may have to keep the source in the repo as it was before (not exported for sharing). And use the option to export for sharing only when we need to update the latest dashboards in grafana.com

I will take a look and get back to you - good catch !

[ehearneRedHat]

@david-martin it seems to be an issue with the data source within the JSON according to this forum thread. I'll see if I can find anything within the JSON that can be removed that will allow the dashboard template be uploaded to Grafana, but also allow the user uploading within their Grafana instance to select their own data source.

[ehearneRedHat]

I believe this could be our problem. Let me see if I can change this back to datasource.

[ehearneRedHat]

@david-martin made changes and tested to see if upload is okay on both Grafana instance and on Grafana Community Dashboards.

[ehearneRedHat]

Feedback to implement from @david-martin :

• Create documentation on how to export the dashboards for use on Grafana (for Community and Local use).
• Create a Bash script that can parse through the JSON and convert an exported dashboard that can be uploaded both to Grafana instance and Grafana Community.
• Create manual GitHub action that can upload the dashboards when changes merged to main branch.

[ehearneRedHat]

Interesting find here that could help automate the process.

Not really - still doesn't export as needed.

[ehearneRedHat]

@david-martin hope the changes suit :)

[ehearneRedHat]

@david-martin Feel free to review - changes are ready for review :)

[ehearneRedHat]

@david-martin I have added git diff within the action to check the changed files. Let me know if there's anything else I need to address. :)

[david-martin]

/lgtm
/approve

Thanks for taking the time to make these improvements @ehearneRedHat

[ehearneRedHat]

Thank you @david-martin for making the suggestions so I can improve my work. :)

…

On Thu, May 16, 2024 at 1:12 PM David Martin ***@***.***> wrote: /lgtm /approve Thanks for taking the time to make these improvements @ehearneRedHat <https://github.com/ehearneRedHat> — Reply to this email directly, view it on GitHub <#641 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BFHWGVLHVXGKQYUDGXJZ6YDZCSPEFAVCNFSM6AAAAABHT44XXCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMJVGA4DOMBVGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Evan Hearne Software Engineer Intern Red Hat <https://www.redhat.com> <https://www.redhat.com>