Skip to content

Commit ac3be4b

Browse files
committed
Extend readme
1 parent 81e2a1c commit ac3be4b

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@
33
A small CLI tool to do a tag-base automatic synchornization and backup Grafana of dashboards across multiple Grafana instances.
44

55
This application can be used to synchronize dashboards, using a Git repository, across multiple Grafana instances.
6-
A possible use case is: push Grafana dashboards from one Grafana instance to a Git repository and import them into another Grafana instance. In addition, users can use tags to determine for themselves when a dashboard should be synchronized.
6+
A possible use cases:
7+
- Backup certain dashboards regularly using a Git repository
8+
- Push Grafana dashboards from one Grafana instance to a Git repository and import them into another Grafana instance. In addition, users can use tags to determine for themselves when a dashboard should be synchronized.
9+
- Preload new Grafana instances with predefined dashboards.
710

8-
As an example this is useful to stage dashboards from "dev" to "prod" environments.
11+
#### Example Usecase
912

10-
The special thing is that the synchronization of dashboards is based on tags, which can be created by the users themselves. Thus, users can determine when a dashboard is ready for synchronization, e.g. so that it is synchronized from a "dev" to a "prod" environment.
13+
This can be useful to stage dashboards from "dev" to "prod" environments.
1114

12-
If a dashboard is imported to Grafana but a dashboard with the same name or ID already exists there, it will be overwritten. For security reasons, dashboards **are not deleted** by the application. If a dashboard is obsolete, it must be deleted manually by the user.
15+
![image](images/dashboard-synchronizer.png)
1316

1417
## Usage
1518

@@ -59,11 +62,10 @@ See the following configuration for available configuration options:
5962
enable: true
6063
# the branch to use for exporting dashboards
6164
git-branch: "push-branch"
62-
# only dashboards with match this pattern will be considered in the sync process.
63-
# this value is a WHITELIST in case it is not empty!!!
65+
# only dashboards with match this pattern will be considered in the sync process
6466
filter: ""
6567
# the tag to determine which dashboards should be exported
66-
tag-pattern: "sync"
68+
tag-pattern: "agent"
6769
# whether the sync-tag should be kept during exporting
6870
push-tags: true
6971

@@ -73,8 +75,7 @@ See the following configuration for available configuration options:
7375
enable: true
7476
# the branch to use for importing dashboards
7577
git-branch: "pull-branch"
76-
# only dashboards with match this pattern will be considered in the sync process.
77-
# this value is a WHITELIST in case it is not empty!!!
78+
# only dashboards with match this pattern will be considered in the sync process
7879
filter: ""
7980

8081
## Development

images/dashboard-synchronizer.png

66.7 KB
Loading

0 commit comments

Comments
 (0)