Merge branch 'simple-task/7546-icinga-check-für-ablaufende-gitlab-tokens' into 'master'

update docs

See merge request !285

docs/20_Checks/about.md

@@ -9,6 +9,12 @@ Its status is always OK.
 
 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
 
 ```txt

docs/20_Checks/check_apache_requests.md

@@ -14,6 +14,13 @@ The check sends performance data for these data too.
 * Apache httpd
 * enabled module mod_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
 

docs/20_Checks/check_ceph_diskfree.md

@@ -13,6 +13,14 @@ It returns a single line for the status, data and performance data.
 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
 
 ```txt

docs/20_Checks/check_ceph_io.md

@@ -13,6 +13,12 @@ It returns a single line for the status and performance data.
 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
 
 ```txt

docs/20_Checks/check_ceph_status.md

@@ -13,6 +13,12 @@ It switches the state in dependency of the HEALTH_* value.
 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
 
 ```txt

docs/20_Checks/check_clientbackup.md

@@ -12,6 +12,12 @@ Script: `check_clientbackup`
 
 * `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
 
 ```txt

docs/20_Checks/check_couchdb.md

@@ -2,15 +2,30 @@
 
 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
 * jq
 * a running couchdb service
 * 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
 
 ```text

docs/20_Checks/check_cpu.md

@@ -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).
 
+## Standalone installation
+
+From this repository ypu need next to this script:
+
+* `inc_pluginfunctions` shared function for all IML checks written in bash
+
 ## Syntax
 
 ``$ check_cpu [-c CRITICAL] [-w WARING] [-i CRITICAL_IO]``

docs/20_Checks/check_cronstatus.md

@@ -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\
 📗 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
 
 ```txt

docs/20_Checks/check_disk_io.md

@@ -10,6 +10,12 @@ It shows a multiline output and sends performance data.
 * `lsblk` List information about block devices
 * `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
 
 ```txt

docs/20_Checks/check_dns_responsetime.md

@@ -8,6 +8,12 @@ Script: `check_dns_responsetime`
 
 * `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
 
 ```txt

docs/20_Checks/check_docker_info.md

@@ -16,12 +16,12 @@ This check sends performance data.
 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
+* `inc_pluginfunctions` shared function for all IML checks written in bash
+* `inc_dockerfunctions.sh`
 
 ## Rootless docker
 

docs/20_Checks/check_docker_stats.md

@@ -16,12 +16,12 @@ This check sends performance data.
 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
+* `inc_pluginfunctions` shared function for all IML checks written in bash
+* `inc_dockerfunctions.sh`
 
 ## Rootless docker
 

docs/20_Checks/check_dockercontainer_top.md

@@ -15,12 +15,12 @@ Script: `check_dockercontainer_top`
 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
+* `inc_pluginfunctions` shared function for all IML checks written in bash
+* `inc_dockerfunctions.sh`
 
 ## Rootless docker
 

docs/20_Checks/check_eol.md

@@ -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.
 
+## 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
 
 ```txt

docs/20_Checks/check_fs_errors.md

@@ -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
 ```
 
+## Standalone installation
+
+From this repository ypu need next to this script:
+
+* `inc_pluginfunctions` shared function for all IML checks written in bash
+
 ## Syntax
 
 ```txt

docs/20_Checks/check_fs_writable.md

@@ -9,6 +9,12 @@ The response is critical of one of the directory is not writable for the icinga
 
 (none)
 
+## Standalone installation
+
+From this repository ypu need next to this script:
+
+* `inc_pluginfunctions` shared function for all IML checks written in bash
+
 ## Syntax
 
 ```txt

docs/20_Checks/check_gitlab_tokens.md

@@ -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`.
 
+## Standalone installation
+
+From this repository ypu need next to this script:
+
+* `inc_pluginfunctions` shared function for all IML checks written in bash
+
 ## Configuration
 
 The script needs to connect to the Gitlab API.

docs/20_Checks/check_haproxy_health.md

@@ -5,6 +5,13 @@ Script: `check_haproxy_health`
 **check_haproxy_health** checks health url of haproxy service.
 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
 
 ```txt

docs/20_Checks/check_haproxy_status.md

@@ -5,6 +5,13 @@ Script: `check_haproxy_status`
 **check_haproxy_health** show status and connections count on frontend and backend.
 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
 
 ```txt