https://github.com/telekom-mms/grafiport
https://github.com/telekom-mms/grafiport
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/telekom-mms/grafiport
- Owner: telekom-mms
- License: gpl-3.0
- Created: 2023-07-12T13:08:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-16T16:21:51.000Z (3 months ago)
- Last Synced: 2025-03-27T18:50:20.005Z (2 months ago)
- Language: Go
- Size: 4.13 MB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Grafiport
This is a Tool to export Grafana objects and store them in JSON Files the filesystem.
In addition to this it can restore the config from the Files and import them back into Grafana.
Restoring of Objects will either update the config if existent or create all new object.
## Usage/Installation
You can install Grafiport either as a container (preferred method) or standalone.
### Docker
Just start a container with following command.
You have to set username, password, url as environment variables.
The default exporting/restoring path inside the container is /output.
Use Volume Mounts to export/restore to/from your file system.
```
docker container -e username= -e password= -e url= --name grafiport grafiport/grafiport
```
Following vars can be set via environment variables:
Note: Don't the directory variable in the container environment, unless you know what you are doing.
| Variable | Flag | Description |
|-----------|--------|---------------------------------------------------------|
| username | String | Username of Grafana instance |
| password | String | Password of Grafana instance |
| url | String | Url of the Grafana Instance |
| directory | String | Target or origin folder of Grafana Config Objects |
| restore | Bool | Activate restore mode. Default: false |
| alerting | Bool | If restoring/exporting config objects consider Alerting |
### non Container environment
Download the executable for your systems OS/architecture in the Release and just execute it. No further installation needed
In non container environments the same variables can be set to configure Grafiport.
You have to set them preferably as Flags instead of environment variables.
But you can set settings as environment variables as well.
```
./grafiport -username -password -url
```
If you need more help just use the -h flag to display the Usage
## Contribute
Feel free to contribute! Use it, test it, give feedback or even Document and code.
Help is always welcome.
## Useful Information
Grafiport exports the configuration in folders generated by itself.
The restore works by using the same folder-names as the export.
So don't rename the folders generated by Grafiport.
### Restore of Alerting Config Objects not recommended
Few Objects in Grafana are not supposed to be configured via api. They result would be an object
which you can't configure anymore [explanation][provisioned_resources].
More to come...
[provisioned_resources]: https://grafana.com/docs/grafana/latest/alerting/set-up/provision-alerting-resources/view-provisioned-resources