Skip to content

Commit fb73c81

Browse files
godspeed-youBenediktSeidl
authored andcommitted
Update README.md
Reflecting the mos recent changes regarding the signed and unsigned plugin.
1 parent 8ae6409 commit fb73c81

File tree

1 file changed

+37
-12
lines changed

1 file changed

+37
-12
lines changed

README.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,56 @@
11
# Checkmk data source
22

3-
![CI](https://github.com/Checkmk/grafana-checkmk-datasource/actions/workflows/ci.yml/badge.svg)
3+
[![Grafana 8.0](https://img.shields.io/badge/Grafana-8.0-orange)](https://www.grafana.com)
4+
[![Checkmk cloud data source](https://img.shields.io/badge/dynamic/json?color=blue&label=Checkmk%20for%20Cloud%20Edition&query=%24.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins%2Fcheckmk-cloud-datasource)](https://grafana.com/grafana/plugins/checkmk-cloud-datasource)
5+
[![Checkmk unsigned data source](https://img.shields.io/badge/dynamic/json?color=blue&label=Checkmk&query=tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2Ftribe29%2Fgrafana-checkmk-datasource%2Freleases%2Flatest)](https://github.com/Checkmk/grafana-checkmk-datasource)
6+
[![CI](https://github.com/Checkmk/grafana-checkmk-datasource/actions/workflows/ci.yml/badge.svg)](https://github.com/Checkmk/grafana-checkmk-datasource/actions/workflows/ci.yml?query=event%3Aschedule)
47

5-
This is a [Grafana][1] [data source][2] plugin for visualizing Checkmk metrics
6-
in Grafana.
78

8-
The plugin requires Checkmk >= 2.1.0 and Grafana >= 8.0
9-
(It is possible query data from Checkmk >= 2.0.0p20 but host and service
10-
dropdowns are not constrained by other active filters and single metric graphs
11-
do not work with Checkmk Raw Edition)
9+
![Checkmk Grafana Data Source Plugin](https://github.com/checkmk/grafana-checkmk-datasource/raw/ebf24142922ccce5cc5649aa4809d1c19d55958f/grafana-checkmk-datasource.png)
10+
## Introduction
1211

13-
All Checkmk Editions are supported by this plugin, but with different query
14-
interface as the Enterprise Edition has a more comprehensive filtering engine.
12+
This [data source][2] plugin for [Grafana][1] allows to address Checkmk as source and to display individual metrics in Grafana.
1513

16-
Please consult the chapter ["Integrating Checkmk in Grafana"][3] in the
17-
official Checkmk documentation on how to use this plugin.
14+
## Requirements
1815

19-
![Checkmk Grafana Data Source Plugin](https://github.com/checkmk/grafana-checkmk-datasource/raw/ebf24142922ccce5cc5649aa4809d1c19d55958f/grafana-checkmk-datasource.png)
16+
To make use of the plugin, you need to take care the correct versions are installed. You need to match both, the Grafana and the Checkmk version:
17+
18+
- **Grafana 8.0.0 or higher**
19+
- **Checkmk Cloud Edition 2.2.0 or higher** for the signed plugin available from [Grafana][6]
20+
- **Checkmk 2.1.0 or higher** for the unsigned plugin available from [Github][8]
21+
22+
## Installing the plug-in
23+
24+
The signed plug-in can be installed from the [Grafana marketplace][6] or by using the `grafana-cli`:
25+
26+
```bash
27+
grafana-cli plugins install checkmk-cloud-datasource
28+
```
29+
30+
For the installation of the unsigned plugin, please take a look at the official [Checkmk user guide][3].
31+
32+
## Official documentation
33+
34+
For detailed information regarding the installation, configuration and usage,
35+
please consult the official [Checkmk User Guide][3].
36+
37+
## Further information
2038

2139
See [CHANGELOG.md][4] for information about updating from previous
2240
versions.
2341

2442
See [DEVELOPMENT.md][5] for information about how to test, build and
2543
release this software.
2644

45+
## License
46+
47+
This project is using the [Apache-2.0 license][7].
48+
2749
[1]: https://grafana.com/grafana/
2850
[2]: https://grafana.com/docs/grafana/latest/datasources/
2951
[3]: https://docs.checkmk.com/latest/en/grafana.html
3052
[4]: https://github.com/checkmk/grafana-checkmk-datasource/blob/main/CHANGELOG.md
3153
[5]: https://github.com/checkmk/grafana-checkmk-datasource/blob/main/DEVELOPMENT.md
54+
[6]: https://grafana.com/grafana/plugins/checkmk-cloud-datasource/
55+
[7]: https://github.com/checkmk/grafana-checkmk-datasource/blob/main/LICENSE
56+
[8]: https://github.com/Checkmk/grafana-checkmk-datasource

0 commit comments

Comments
 (0)