Skip to content
Snippets Groups Projects
Commit 6d2190d5 authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

update docs

parent a9ed9bda
No related branches found
No related tags found
1 merge request!285update docs
Showing
with 132 additions and 14 deletions
...@@ -9,6 +9,12 @@ Its status is always OK. ...@@ -9,6 +9,12 @@ Its status is always OK.
Nothing special. Nothing special.
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -14,6 +14,13 @@ The check sends performance data for these data too. ...@@ -14,6 +14,13 @@ The check sends performance data for these data too.
* Apache httpd * Apache httpd
* enabled module mod_status * enabled module mod_status
* allow localhost to access /server-status * allow localhost to access /server-status
* wget
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
......
...@@ -13,6 +13,14 @@ It returns a single line for the status, data and performance data. ...@@ -13,6 +13,14 @@ It returns a single line for the status, data and performance data.
icingaclient ALL=(ALL) NOPASSWD: /bin/ceph icingaclient ALL=(ALL) NOPASSWD: /bin/ceph
``` ```
## Standalone installation
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -13,6 +13,12 @@ It returns a single line for the status and performance data. ...@@ -13,6 +13,12 @@ It returns a single line for the status and performance data.
icingaclient ALL=(ALL) NOPASSWD: /bin/ceph icingaclient ALL=(ALL) NOPASSWD: /bin/ceph
``` ```
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -13,6 +13,12 @@ It switches the state in dependency of the HEALTH_* value. ...@@ -13,6 +13,12 @@ It switches the state in dependency of the HEALTH_* value.
icingaclient ALL=(ALL) NOPASSWD: /bin/ceph icingaclient ALL=(ALL) NOPASSWD: /bin/ceph
``` ```
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -12,6 +12,12 @@ Script: `check_clientbackup` ...@@ -12,6 +12,12 @@ Script: `check_clientbackup`
* `IML Backup` must be installed. * `IML Backup` must be installed.
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -2,15 +2,30 @@ ...@@ -2,15 +2,30 @@
Script: `check_couchdb` Script: `check_couchdb`
Check couchdb status. Check couchdb status. This check contains different modes for several checks.
### Requirements * counters for http request types
* counters for http request methods
* number of open databases
* number of file descriptors CouchDB has open
* last replication status
* count of pending updates for nodes, dbs and users
* last replication status
* general couchdb health status
## Requirements
* curl * curl
* jq * jq
* a running couchdb service * a running couchdb service
* authentication (see section Installation below) * authentication (see section Installation below)
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```text ```text
......
...@@ -20,6 +20,12 @@ For all values it sends performance data. ...@@ -20,6 +20,12 @@ For all values it sends performance data.
If there are processes with status D they will be shown (to analyze cpu waits). If there are processes with status D they will be shown (to analyze cpu waits).
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
``$ check_cpu [-c CRITICAL] [-w WARING] [-i CRITICAL_IO]`` ``$ check_cpu [-c CRITICAL] [-w WARING] [-i CRITICAL_IO]``
......
...@@ -23,6 +23,12 @@ As output you get a summary of all checks followed by more detailed status per j ...@@ -23,6 +23,12 @@ As output you get a summary of all checks followed by more detailed status per j
📜 License: GNU GPL 3.0\ 📜 License: GNU GPL 3.0\
📗 Docs: see docs folder or online <https://www.axel-hahn.de/docs/cronwrapper/> 📗 Docs: see docs folder or online <https://www.axel-hahn.de/docs/cronwrapper/>
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -10,6 +10,12 @@ It shows a multiline output and sends performance data. ...@@ -10,6 +10,12 @@ It shows a multiline output and sends performance data.
* `lsblk` List information about block devices * `lsblk` List information about block devices
* `bc` calculator * `bc` calculator
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -8,6 +8,12 @@ Script: `check_dns_responsetime` ...@@ -8,6 +8,12 @@ Script: `check_dns_responsetime`
* `nslookup` query Internet name servers * `nslookup` query Internet name servers
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -16,12 +16,12 @@ This check sends performance data. ...@@ -16,12 +16,12 @@ This check sends performance data.
icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker
``` ```
## Includes ## Standalone installation
Additional needed files in the current folder that this check can run: From this repository ypu need next to this script:
* inc_dockerfunctions.sh * `inc_pluginfunctions` shared function for all IML checks written in bash
* inc_pluginfunctions * `inc_dockerfunctions.sh`
## Rootless docker ## Rootless docker
......
...@@ -16,12 +16,12 @@ This check sends performance data. ...@@ -16,12 +16,12 @@ This check sends performance data.
icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker
``` ```
## Includes ## Standalone installation
Additional needed files in the current folder that this check can run: From this repository ypu need next to this script:
* inc_dockerfunctions.sh * `inc_pluginfunctions` shared function for all IML checks written in bash
* inc_pluginfunctions * `inc_dockerfunctions.sh`
## Rootless docker ## Rootless docker
......
...@@ -15,12 +15,12 @@ Script: `check_dockercontainer_top` ...@@ -15,12 +15,12 @@ Script: `check_dockercontainer_top`
icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker
``` ```
## Includes ## Standalone installation
Additional needed files in the current folder that this check can run: From this repository ypu need next to this script:
* inc_dockerfunctions.sh * `inc_pluginfunctions` shared function for all IML checks written in bash
* inc_pluginfunctions * `inc_dockerfunctions.sh`
## Rootless docker ## Rootless docker
......
...@@ -10,6 +10,14 @@ The status is "unknown" if a product or the eol date was not detected. ...@@ -10,6 +10,14 @@ The status is "unknown" if a product or the eol date was not detected.
It is customizable / extendable to detect other products that are not included in the delivered basic config. It is customizable / extendable to detect other products that are not included in the delivered basic config.
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
* `./check_eol-data/*` end of life data for several products
* `./check_eol-versiondetect/*` scripts to detect a version per product
## Syntax ## Syntax
```txt ```txt
......
...@@ -15,6 +15,12 @@ If it would find error messages it switches to critical and shows the found jour ...@@ -15,6 +15,12 @@ If it would find error messages it switches to critical and shows the found jour
icingaclient ALL=(ALL) NOPASSWD: /bin/journalctl icingaclient ALL=(ALL) NOPASSWD: /bin/journalctl
``` ```
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -9,6 +9,12 @@ The response is critical of one of the directory is not writable for the icinga ...@@ -9,6 +9,12 @@ The response is critical of one of the directory is not writable for the icinga
(none) (none)
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Syntax ## Syntax
```txt ```txt
......
...@@ -21,6 +21,12 @@ The check returns ...@@ -21,6 +21,12 @@ The check returns
Extract or Git pull the Bash REST API client somewhere in your filesystem. eg. /opt/bash-api-client/. With the parameter `-r <FILE>` you point to the file `rest-api-client.sh`. Extract or Git pull the Bash REST API client somewhere in your filesystem. eg. /opt/bash-api-client/. With the parameter `-r <FILE>` you point to the file `rest-api-client.sh`.
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
## Configuration ## Configuration
The script needs to connect to the Gitlab API. The script needs to connect to the Gitlab API.
......
...@@ -5,6 +5,13 @@ Script: `check_haproxy_health` ...@@ -5,6 +5,13 @@ Script: `check_haproxy_health`
**check_haproxy_health** checks health url of haproxy service. **check_haproxy_health** checks health url of haproxy service.
The url of it will be detected from /etc/haproxy/haproxy.cfg. The url of it will be detected from /etc/haproxy/haproxy.cfg.
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
* `inc_haproxy_cfg.sh` shared function to parse HA proxy config
## Syntax ## Syntax
```txt ```txt
......
...@@ -5,6 +5,13 @@ Script: `check_haproxy_status` ...@@ -5,6 +5,13 @@ Script: `check_haproxy_status`
**check_haproxy_health** show status and connections count on frontend and backend. **check_haproxy_health** show status and connections count on frontend and backend.
This check sends performance data. This check sends performance data.
## Standalone installation
From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash
* `inc_haproxy_cfg.sh` shared function to parse HA proxy configs
## Syntax ## Syntax
```txt ```txt
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment