https://github.com/netcracker/qubership-grafana-plugins-init
Container with Grafana plugins for deployment Grafana in isolated environments
https://github.com/netcracker/qubership-grafana-plugins-init
monitoring observability qubership-observability
Last synced: 10 months ago
JSON representation
Container with Grafana plugins for deployment Grafana in isolated environments
- Host: GitHub
- URL: https://github.com/netcracker/qubership-grafana-plugins-init
- Owner: Netcracker
- License: apache-2.0
- Created: 2024-12-19T13:33:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-04T07:37:21.000Z (11 months ago)
- Last Synced: 2025-08-04T10:54:20.928Z (11 months ago)
- Topics: monitoring, observability, qubership-observability
- Language: Shell
- Homepage:
- Size: 66.4 KB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Overview
[](https://github.com/Netcracker/qubership-grafana-plugins-init/actions/workflows/build.yaml)
[](https://github.com/Netcracker/qubership-grafana-plugins-init/actions/workflows/link-checker.yaml)
[](https://github.com/Netcracker/qubership-grafana-plugins-init/actions/workflows/super-linter.yaml)
This init container is intended for grafana customization with predefined list of plugins.
All the plugins listed in plugins list file will be added to grafana while appropriate grafana pod start in Kubernetes.
These plugins are downloaded while this image build instead of init container runtime.
## Plugins list
* DataSources:
* [ClickHouse 3.4.3](https://grafana.com/grafana/plugins/vertamedia-clickhouse-datasource)
* [JSON 0.6.7](https://grafana.com/grafana/plugins/simpod-json-datasource)
* [GraphQL Data Source 1.5.0](https://grafana.com/grafana/plugins/retrodaredevil-wildgraphql-datasource)
* [Infinity 3.2.1](https://grafana.com/grafana/plugins/yesoreyeram-infinity-datasource)
* [VictoriaMetrics 0.16.0](https://grafana.com/grafana/plugins/victoriametrics-metrics-datasource)
* [VictoriaLogs 0.18.1](https://grafana.com/grafana/plugins/victoriametrics-logs-datasource)
* Applications:
* [Grafana OnCall 1.16.3](https://grafana.com/grafana/plugins/grafana-oncall-app)
* [Grafana Logs Drilldown 1.0.20](https://grafana.com/grafana/plugins/grafana-lokiexplore-app)
* [Grafana Traces Drilldown 1.1.0](https://grafana.com/grafana/plugins/grafana-exploretraces-app)
* [Grafana Profiles Drilldown 1.4.1](https://grafana.com/grafana/plugins/grafana-pyroscope-app)
* Panels:
* [Breadcrumb Panel 1.2.0](https://grafana.com/grafana/plugins/timomyl-breadcrumb-panel)
* [D3 Gauge 2.0.4](https://grafana.com/grafana/plugins/briangann-gauge-panel)
* [Diagram 1.10.4](https://grafana.com/grafana/plugins/jdbranham-diagram-panel)
* [Service Dependency Graph 4.2.0](https://grafana.com/grafana/plugins/novatec-sdg-panel)
* [Status Panel 2.0.2](https://grafana.com/grafana/plugins/vonage-status-panel)
* [SVG 0.1.5](https://grafana.com/grafana/plugins/aceiot-svg-panel)
* [HTML graphics 2.1.1](https://grafana.com/grafana/plugins/gapit-htmlgraphics-panel)
## How to it work
During build grafana-plugin-init container all plugins download from
[https://grafana.com/api/plugins](https://grafana.com/api/plugins)
(User interface available by link [https://grafana.com/grafana/plugins/](https://grafana.com/grafana/plugins/))
and add into docker image.
When operator create or update Grafana deployment it create deployment with two containers:
* grafana-plugins-init - `initContainer` which run with volume `grafana-plugins` (mount to `/opt/plugins`) in which it
copy all plugins
* grafana - `container` with Grafana which also has volume `grafana-plugins` (mount to `/var/lib/grafana/plugins`)
When pod `grafana-deployment` start with init container, it always run first and execute initialize actions.
So when `initContainer` start it copy all plugins from image to mounted volume `grafana-plugins`.
Next it complete it work and grafana container start also with volume `grafana-plugins`.
Structure of init image:
```bash
/
└── entrypoint.sh
└── etc
└── grafana
└── plugins
├── NeoCat-grafana-cal-heatmap-panel-d7d3579
├── Vonage-Grafana_Status_panel-ca77e0d
├── algenty-grafana-flowcharting-276ca4a
├── black-mirror-1-singlestat-math-0aca146
├── briangann-gauge-panel
├── ...
└── vertamedia-clickhouse-datasource
```
## How to add plugin
There is file `plugins.list` which contains plugin name and plugin version specified via space separator.
Currently plugins can be download only from:
```bash
https://grafana.com/api/plugins
```
Format:
```bash
```
For example for include plugin which store on artifactory by link:
```bash
https://grafana.com/api/plugins/briangann-gauge-panel/versions/2.0.1/download
```
need specify:
```bash
briangann-gauge-panel 2.0.1
```
## How to add plugin manually
In some cases it may be necessary add plugin which was downloaded manually from Grafana.com or from any other source.
For build this image locally with custom plugins need:
1. Edit `download_plugins.sh` and comment step for remove directory `/tmp/plugins`
```bash
echo "=> Remove directories from pervious build..."
rm -rf ${DESTINATION_PATH}
mkdir -p ${DESTINATION_PATH}
```
2. Download and extract folder with plugin to `/tmp/plugins`. For example:
```bash
/tmp
└── /plugins
└── /
└──
└── /
└──
```
3. Run
```bash
docker build .
```
During build script `docker build` download all plugins as ZIP files into `/tmp/downloads`.
Then it unarchive all plugins into `/tmp/plugins`.
And during build docker image docker will copy all files from `/tmp/plugins` to `/etc/grafana/plugins/`.