Skip to content

Commit

Permalink
Merge pull request #111 from smandaRH/readme
Browse files Browse the repository at this point in the history
Updating README.md file
  • Loading branch information
vishnuchalla authored Mar 17, 2024
2 parents 578888b + 022e1ee commit c9eaf01
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Managing grafana dashboards in a CVS is not an easy task, since the exported dashboards by Grafana do not have always the same json layout due to the nature of the own json format.
When exporting a Grafana dashboard json keys may be exported in different order. In addition, dealing with such complex json files is not an easy task since it's usually required import & export the full dashboard to perform a minimal modification or update.

Jsonnet based dashboards is an effort to improve the manageability of grafana json dashboards by leveraging the libraries included at the project [grafonnet-lib](https://github.com/grafana/grafonnet-lib). Using this mechanism of dashboards as code will improve versioning and make simplify collaboration.
Jsonnet based dashboards is an effort to improve the manageability of grafana json dashboards by leveraging the libraries included at the project [grafonnet-lib](https://github.com/grafana/grafonnet-lib). But grafonnet-lib had a hard time to keep up with Grafana development, this resulted in it being under-maintained. [Grafonnet](https://github.com/grafana/grafonnet) jsonnet library which is generated from JSON Schemas generated by [Grok](https://github.com/grafana/grok), these schemas are generated directly from the Grafana repository to ensure Grafonnet can keep up with Grafana development. Using this mechanism of dashboards as code will improve versioning and make simplify collaboration.

## How to

Expand Down Expand Up @@ -70,15 +70,24 @@ rm -rf bin rendered tmp templates/grafonnet-lib
## Templates available

The following templates are available:

- API Performance Dashboard
- Etcd Dashboard
- OpenShift Performance Dashboard
- OVN Dashboard
- Pgbench Dashboard
- UPerf Results Dashboard
- Vegeta Dashboard
- YCSB Dashboard

- CPT
- [x] Ingress Perf Dashboard.
- [x] K8s Netperf Dashboard.
- [x] Kube Burner Report OCP Wrapper dashboard.
- General
- [x] API Performance Dashboard.
- [x] Cilium K8s Performance Dashboard.
- [x] Etcd Dashboard.
- [ ] Hypershift Performance Dashboard.
- [x] K8s Performance Dashboard.
- [ ] Kube Burner Dashboard.
- [x] OpenShift Performance Dashboard.
- [x] OVN Dashboard.
- [x] Pgbench Dashboard.
- [x] UPerf Results Dashboard.
- [x] Vegeta Dashboard.
- [x] YCSB Dashboard.

## Dittybopper

Expand All @@ -95,4 +104,4 @@ In addition, make sure to lint your modifications to jsonnet files if you don't

The dashboards from this repository have been tested with the following versions:

- Grafana 7.X
- Grafana 9.X

0 comments on commit c9eaf01

Please sign in to comment.