Skip to content

Commit e4047d7

Browse files
committed
docs: update ICINGA
1 parent 308b401 commit e4047d7

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

ICINGA.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,18 @@
44

55
### Single / specific Plugins
66

7-
By importing Baskets
7+
#### By importing Baskets
8+
89
For each check, we provide an Icinga Director Basket that contains at least the Command definition and a matching Service Template (for example, `check-plugins/cpu-usage/icingaweb2-module-director/cpu-usage.json`). Import this:
910

1011
* either via the WebGUI using Icinga Director \> Configuration Baskets \> Upload, select the latest entry in the Snapshots tab and restore it
1112
* or via `icingacli director basket restore < cpu-usage.json -v`
1213

1314
Now use the new commands within Service Templates, Service Sets and/or a Single Services.
1415

15-
By defining them manually
16+
17+
#### By defining them manually
18+
1619
If you want to define plugins manually, this is how to do it (example).
1720

1821
Create a command for "cpu-usage" in Icinga Director \> Commands \> Commands:
@@ -40,6 +43,7 @@ Tab "Fields":
4043
* Label "CPU Usage: Critical", Field name "cpu_usage_critical", Mandatory "n"
4144
* Label "CPU Usage: Warning", Field name "cpu_usage_warning", Mandatory "n"
4245

46+
4347
### All Plugins (Linuxfabrik Icinga Director Configuration)
4448

4549
To use the Linuxfabrik Icinga Director configuration, including host templates, notification templates and predefined service sets, you need to *generate* a single Icinga Director basket file containing the baskets for each check plus [all-the-rest.json](https://github.com/Linuxfabrik/monitoring-plugins/blob/main/assets/icingaweb2-module-director/all-the-rest.json). Use [tools/basket-join](https://github.com/Linuxfabrik/monitoring-plugins/blob/main/tools/basket-join) to do this.
@@ -48,28 +52,31 @@ Create the Icinga Director Basket JSON file:
4852

4953
* If you are using our [Fork of the Icinga Director](https://github.com/Linuxfabrik/icingaweb2-module-director), which introduced uuids, you can use the following command:
5054

51-
```bash
52-
./tools/basket-join
53-
```
55+
```bash
56+
./tools/basket-join
57+
```
5458

55-
* If you are NOT using our [Fork of the Icinga Director](https://github.com/Linuxfabrik/icingaweb2-module-director), create a basket without uuids:
59+
* If you are NOT using our Fork of the Icinga Director, create a basket without uuids:
5660

57-
```bash
58-
./tools/basket-join
59-
./tools/remove-uuids --input-file icingaweb2-module-director-basket.json --output-file icingaweb2-module-director-basket-no-uuids.json
60-
```
61+
```bash
62+
./tools/basket-join
63+
./tools/remove-uuids \
64+
--input-file icingaweb2-module-director-basket.json \
65+
--output-file icingaweb2-module-director-basket-no-uuids.json
66+
```
67+
68+
If you did not name your master zone `master` during the initial `icinga2 node wizard`, find and replace `"zone": "master"` with `"zone": "your-master-zone-name"` in the `icingaweb2-module-director-basket.json` file.
6169

6270
Import the resulting `icingaweb2-module-director-basket.json`:
6371

6472
* either via the WebGUI using *Icinga Director \> Configuration Baskets \> Upload*, select the latest entry in the Snapshots tab and restore it
65-
* or via `icingacli director basket restore < icingaweb2-module-director-basket.json -v`.
73+
* or via `icingacli director basket restore < icingaweb2-module-director-basket.json -v` (preferred).
6674

6775
If you get the error message `File 'icingaweb2-module-director-basket.json' exeeds the defined ini size.`, adjust your PHP and/or MariaDB/MySQL settings (as described in [Cant Upload Director Basket](https://github.com/Icinga/icingaweb2-module-director/issues/2458)):
6876

6977
* PHP: increase `upload_max_filesize` and `post_max_size` (if you use PHP-FPM, don't forget to restart this service).
7078
* MariaDB/MySQL: increase `max_allowed_packet`.
7179

72-
If you did not name your master zone `master` during the initial `icinga2 node wizard`, find and replace `"zone": "master"` with `"zone": "your-master-zone-name"` in the `icingaweb2-module-director-basket.json` file.
7380

7481
## Linuxfabrik's Icinga Director Concept
7582

@@ -79,6 +86,7 @@ In general, all of our services are in a service set, which is then applied to a
7986

8087
For some services it does not make sense to create a set, for example when monitoring an external website using `tpl-service-url`. In this case you can create a single service on that host.
8188

89+
8290
### Criticality
8391

8492
To manage notifications we use a custom variable called `criticality`. This variable is present on both services and hosts and is used to determine if and during what time period a notification is sent.

0 commit comments

Comments
 (0)