Release Notes

Summary

PIET is an acronym for (Pleasant and Intelligent grafana-backup Execution Tool). It is a backup tool for Grafana which is only able to store dashboard versions on the local harddrive, making it difficult to recover dashboards in the case of i.e. an outage. PIET solves this problem by providing a user with backup and publish commands to backup all/certain dashboards and install backed up version of them.

Installation

1. Clone repository into folder piet
2. cd piet
3. ln -s core.py ./bin/piet
4. chmod +x ./bin/piet
5. export PATH="piet/bin:$PATH" into ~/.zshrc or ~/.bashrc
6. Restart terminal

20.06.2022 - 23.06.2022

1. Downloading Grafana Dashboard from Grafana
2. Commiting Grafana Dashboard to GitHub
3. Downloading Grafana Dashboard from GitHub
4. Installing Grafana Dashboard into Grafana
   1. If the dashboard really got deleted,then step 4 will restore it
   2. If the dashboard is still existing (given still the same name, folder, uid and id, Grafana will refuse to create a new dashboard with the following error message: "A dashboard with the same name in the folder already exists" OR "A dashboard with the same uid already exists"
   3. If the user wants to replace the existing dashboard with some version from GitHub, he can enable the overwrite=True option, overwriting the existing dashboard with the new data (TEST NECESSARY)!! (INSTALLATION INTO ANYTHING OTHER THAN THEN GENERAL FOLDER IS CURRENTLY NOT POSSIBLE)
   4. If the user wants the version from GitHub but also does not want to loose the existing version of the dashboard, he can enable the create_copy=True option, which will not delete the existing dashboard but rather uploads the GitHub dashboard seperately with a name similar to "NAME-Copy-Y/m/d-H:M:S"

24.06.2022

1. The main code (scraper.py) has been broken into modules and classes according to the project graph.
   • Following modules and classes have been created:
     • Grafana
     • GitHub
     • Core
     • CLI
2. The "sync" command has been added as an idea to easily combine the fundamental commands "backup" and "publish". It can only be used to synchronise everything, not single files or directories.

27.06.2022

1. Added dashboard structure
2. WIP on the transition to modularization
3. Further improvements

28.06.2022

1. Transition to a fully modular approach is done
2. Everything is controlled by the core module
3. Terminal ouput is prettified using colorama
4. Added ArgumentParser for the "backup" command
   1. "python3 core.py backup --everything True" works totally fine
   2. "python3 core.py backup --path 'folder/dashboard'" works totally fine

29.06.2022

1. The whole backup functionality is working
2. Better Error messages and hints for what went wrong or could go wrong
3. Syntax highlighting: More important terminal output is highlighted bolder and more colorful
4. The "publish" command has got better error handling and a list of working parameters combinations has also been added:

   [x] --commit-id & --path        (works only if there is no dashboard with the same name or uid on the given path!)
   [x] --commit-id & --path & --overwrite
   [ ] --commit-id & --path & --create-copy
   
   [ ] --everything                (ONLY uses latest commits!)
   [ ] --everthing & --overwrite   (ONLY uses latest commits!)
   [ ] --everthing & --create-copy (ONLY uses latest commits!)
   

5. Current execution is possible by typing following commands:

   python3 core.py backup --path <path/to/db> --everything <True/False>
   python3 core.py publish --commit_id <commit-oid> --path <path/to/db> --everything <True/False> --overwrite <True/False>
   (python3 core.py sync)
   

30.06.2022

1. Finished publish command functionality
2. Fixed the last bugs
3. Done!

Modulestructure

• Core (CLI)(main)
  • Interfacing of all system components
  • Passing input data from shell into certain components
  • Passing output data back to shell
  • Parsing and validating input data
• GitHub
  • For handling everything that concerns the GitHub REST- and GraphQL API
• Grafana
  • For handling everything that concers the Grafana API
• Config
  • config.json (into .gitignore for security purposes)
    • For saving:
      • API_KEYS
      • Grafana Login Data
      • GitHub Repository Owner and Name

Developed @ Adobe, Used by Adobe Systems Engineering GmbH