Collection of CheckMK checks (see https://checkmk.com/). All checks and plugins are provided as is. Absolutely no warranty. Send any comments to thl-cmk[at]outlook[dot]com

Skip to content
README.md 3.87 KiB
Newer Older
thl-cmk's avatar
thl-cmk committed
[PACKAGE]: ../../raw/master/mkp/checkmk_update-0.3.0-20240430.mkp "checkmk_update-0.3.0-20240430.mkp"
thl-cmk's avatar
thl-cmk committed
# Checkmk update 
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
This plugin mointors the update status of your CMK sites and your CMK appliance firmware. The plugin reads it's data once a day form the Checkmk download page (**https://download.checkmk.com/stable_downloads.json**).
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
THX to Baris Leenders for providing the data as JSON download and Martin Hirschvogel for supporting the development of this plugin (both from tribe29).
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
**NOTE**: before updating from the special agent version of this plugin, remove the old package completely (rules and package) please. 
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
**NOTE**: to get the download URLs in the service details not replaced by CMK you need to disable `Escape HTML in service output` (_Setup_ > _Services_ > _Service monitoring rules_ > _Escape HTML in service output_) for the service `Checkmk Update`.

thl-cmk's avatar
thl-cmk committed
---
thl-cmk's avatar
thl-cmk committed
### Prerequisites
thl-cmk's avatar
thl-cmk committed

For the check plugin to work
- Your CMK site servers need to run check-mk agent version 2.0.0 or higher to get CMK site informations
thl-cmk's avatar
thl-cmk committed
- The HW/SW inventory plugin for Linux must be installad and running (`mk_inventory.linux` agent plugin needs to be deployed)
- The CMK server, where the check runs must have access to **https://download.checkmk.com/stable_downloads.json**
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
---
thl-cmk's avatar
thl-cmk committed
### Download
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
* [Download latest mkp file][PACKAGE]
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
**Note**: before you update to a newer version, alway check the [CHANGELOG](CHANGELOG). There migth be incompatible changes.

thl-cmk's avatar
thl-cmk committed
---
### Installation

thl-cmk's avatar
thl-cmk committed
You can install the package by uploading it to your CheckMK site and as site user run 
```
mkp install PACKAGENAME-VERSION.mkp
```
or beginning with CMK2.2.x
```
mkp add PACKAGENAME-VERSION.mkp
mkp enable PACKAGENAME VERSION
```
In the non RAW editions of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_)
thl-cmk's avatar
thl-cmk committed

---
thl-cmk's avatar
thl-cmk committed
#### Want to contribute?
Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")

---
#### Check Info:
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
The plugin creates the service **_Checkmk Update_** with the CMK site name as the _item_

<details><summary>Montoring states</summary>

| State | condition | WATO | 
| ------ | ------ | ------ |
| CRIT | if CMK base version is older than old stable base version | yes |
| WARN | if CMK version is older than latest version of base version | yes |
| WARN | if CMK version is an old stable release | yes |
| WARN | if CMK base version could not be detected | yes |
| CRIT | if CMK appliance firmware is unsupported | yes |
| WARN | if CMK appliance firmware update is available (same base version) | yes |
| WARN | if CMK appliance firmware is not the latest release | yes |

</details>

<details><summary>Perfdata</summary>

| Metric | Unit | Perfometer | |
| ------ | ------ | ------ | ----- |
thl-cmk's avatar
thl-cmk committed
| 1.6.0 | count | no | Patchlevel of CMK version 1.6.0 |
| 2.0.0 | count | no | Patchlevel of CMK version 2.0.0 |
| 2.1.0 | count | no | Patchlevel of CMK version 2.1.0 |
| 2.2.0 | count | no | Patchlevel of CMK version 2.2.0 |
thl-cmk's avatar
thl-cmk committed

</details>
thl-cmk's avatar
thl-cmk committed

---
thl-cmk's avatar
thl-cmk committed
### WATO
<details><summary>Service monitoring rule</summary>

| Section | Rule name |
| ------ | ------ |
| Operating System Resources | Checkmk update  |

| Option | Defailt value |
| ------ | ------ |
| State if CMK base version older than old stable base version. | CRIT |
| State if CMK version is older than latest version of base version. | WARN |
| State if CMK version is an old stable release. | WARN |
| State if CMK base version could not be detected. | WARN |
| State if CMK appliance firmware is unsupported. | CRIT |
| State if CMK appliance firmware update available (same base version). | WARN |
| State if CMK appliance firmware is not the latest release. | WARN |
| Connection Timeout for update data download | 5 seconds |

</details> 
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed
---
thl-cmk's avatar
thl-cmk committed
Sample output

thl-cmk's avatar
thl-cmk committed
![sample output](/img/sample.png?raw=true "sample output")
thl-cmk's avatar
thl-cmk committed

thl-cmk's avatar
thl-cmk committed

Sample details output

thl-cmk's avatar
thl-cmk committed
![sample details output](/img/sample-details.png?raw=true "sample details output")