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

Update docs

See merge request !302

check_apache_requests

@@ -13,13 +13,13 @@
 # 2022-08-31  v1.4  <axel.hahn@iml.unibe.ch>  add help; shellfix corrections
 # 2023-06-19  v1.5  <axel.hahn@unibe.ch>      no more tmpfile
 # 2023-07-27  v1.6  <axel.hahn@unibe.ch>      update help page
-# 2025-02-10  v1.3  <axel.hahn@unibe.ch>      harden sourcing files
+# 2025-02-10  v1.7  <axel.hahn@unibe.ch>      harden sourcing files
 # ======================================================================
 
 # shellcheck source=/dev/null
 . "$( dirname "$0" )/inc_pluginfunctions" || exit 1
 
-export self_APPVERSION=1.6
+export self_APPVERSION=1.7
 
 # url=`hostname -f`/server-status
 url=localhost/server-status

check_deployment

@@ -36,7 +36,7 @@ OPTIONS:
                    default: ${sInstalldir}
 
 EXAMPLE:
-$_self -d /home/deployuser/imlbackup
+$_self -d /home/deployuser/imldeployment-installer
                    set a custom directory und run the backup check
 
 EOF

docs/20_Checks/about.md

@@ -11,7 +11,7 @@ Nothing special.
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -21,7 +21,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 ABOUT
-v1.2
+v1.3
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_apache_requests.md

@@ -18,7 +18,7 @@ The check sends performance data for these data too.
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -28,7 +28,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 CHECK_APACHE_REQUESTS
-v1.6
+v1.7
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_ceph_diskfree.md

@@ -17,7 +17,7 @@ icingaclient ALL=(ALL) NOPASSWD: /bin/ceph
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 

docs/20_Checks/check_ceph_io.md

@@ -15,7 +15,7 @@ icingaclient ALL=(ALL) NOPASSWD: /bin/ceph
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -25,7 +25,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 CHECK_CEPH_IO
-v1.5
+v1.6
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_ceph_osd.md

@@ -22,7 +22,7 @@ icingaclient ALL=(ALL) NOPASSWD: /bin/ceph
 ______________________________________________________________________
 
 CHECK_CEPH_OSD 
-v1.6
+v1.8
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_ceph_status.md

@@ -15,7 +15,7 @@ icingaclient ALL=(ALL) NOPASSWD: /bin/ceph
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -25,7 +25,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 CHECK_CEPH_STATUS
-v1.8
+v1.9
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_clientbackup.md

@@ -14,7 +14,7 @@ Script: `check_clientbackup`
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -25,7 +25,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 CHECK_CLIENTBACKUP 
-v1.12
+v1.14
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_conn.md

@@ -6,7 +6,7 @@ It is a plugin to check oe or mmultiple tcp and udp connections to localhost or
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -16,7 +16,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 CHECK_CONN
-v1.2
+v1.3
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_couchdb.md

@@ -22,7 +22,7 @@ Check couchdb status. This check contains different modes for several checks.
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -33,7 +33,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 CHECK_COUCHDB
-v0.7
+v1.0
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_cpu.md

@@ -22,24 +22,55 @@ 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:
+From this repository you 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]``
+```txt
+> check_cpu -h
+______________________________________________________________________
+
+CHECK_CPU
+v1.16
+
+(c) Institute for Medical Education - University of Bern
+Licence: GNU GPL 3
+
+https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_cpu.html
+______________________________________________________________________
+
+check cpu usage and cpu wait
+Cpu infos are taken from output of top command.
+
+On higher cpu usage it can show processes that cause cpu waits and
+with most cpu consumption.
+
+SYNTAX:
 
-### Parameters
+    check_cpu [-w WARN_LIMIT] [-c CRITICAL_LIMIT] [-i CRITICAL_IO_WAIT] [-p PROCESS_LIMIT]
+
+OPTIONS:
 
-```text
     -w VALUE       cpu usage warning level  (default: 75)
     -c VALUE       cpu usage critical level (default: 90)
 
     -i VALUE       io wait critical level   (default: 50)
 
+    -p VALUE       show process info with highest cpu consumption if 
+                   usage is > NN %; default: 50
+
     -h or --help   show this help.
 
+PARAMETERS:
+
+    None.
+
+EXAMPLE:
+
+    check_cpu -w 60 -c 80 -p 40
+
 ```
 
 ## Examples

docs/20_Checks/check_cronstatus.md

@@ -25,7 +25,7 @@ As output you get a summary of all checks followed by more detailed status per j
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -35,7 +35,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 CHECK_CRONSTATUS
-v2.4
+v2.5
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_deployment.md

+## Check Deployment
+
+Script: `check_deployment`
+
+This is a check for the IML deployment client that downloads and installs an application package.
+This check starts the script `check_deployment.sh` that is part of the IML deployment client.
+
+It returns 
+
+* OK if all apps were installed/ updated successfully.
+* Unknown on exitcode 0 but the OK message for a successful installation was not found
+* Error on non zero exitcode because download, installation or replacement for configuration files failed.
+
+## Requirements
+
+* The IML deployment client must be installed
+
+📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/imldeployment-client/>\
+📜 License: GNU GPL 3.0\
+📗 Docs: see docs folder or online <https://os-docs.iml.unibe.ch/imldeployment-client/>
+
+## Standalone installation
+
+From this repository you need next to this script:
+
+* `inc_pluginfunctions` shared function for all IML checks written in bash
+
+## Syntax
+
+```txt
+______________________________________________________________________
+
+CHECK_DEPLOYMENT
+v1.0
+
+(c) Institute for Medical Education - University of Bern
+Licence: GNU GPL 3
+
+https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_deployment.html
+______________________________________________________________________
+
+Show status of rollouts with IML deployment client on this system.
+See https://os-docs.iml.unibe.ch/imldeployment-client/
+
+SYNTAX:
+check_deployment [-d DIRECTORY]
+
+OPTIONS:
+    -h or --help   show this help.
+    -d or --dir    set installation dir of iml deployment to find its check skript
+                   default: /opt/imldeployment-installer
+
+EXAMPLE:
+check_deployment -d /home/deployuser/imldeployment-installer
+                   set a custom directory und run the backup check
+
+```
+
+## Examples
+
+The script has no parameter. It shows all created profiles and its installation status based on the latest found logfile.
+
+```txt
+OK: Deployment ... Profiles: 2 ... Errors: 0
+OK: myapp_a - /var/log/imldeployment-client/myapp_a__2025-02-20__030307.log
+OK: myapp_b - /var/log/imldeployment-client/myapp_b__2025-02-20__030329.log
+```

docs/20_Checks/check_disk_io.md

@@ -12,7 +12,7 @@ It shows a multiline output and sends performance data.
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -22,7 +22,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 CHECK_DISK-IO 
-v1.1
+v1.2
 
 Check dis io and latency
 

docs/20_Checks/check_dns_responsetime.md

@@ -10,7 +10,7 @@ Script: `check_dns_responsetime`
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 
@@ -20,7 +20,7 @@ From this repository ypu need next to this script:
 ______________________________________________________________________
 
 CHECK_DNS_RESPONSETIME 
-v1.4
+v1.5
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_docker_info.md

@@ -18,7 +18,7 @@ icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 * `inc_dockerfunctions.sh`
@@ -37,7 +37,7 @@ If DOCKER_HOST is not set then the docker socket is detected from a running dock
 ______________________________________________________________________
 
 CHECK_DOCKER_INFO
-v1.5
+v1.6
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_docker_io.md

@@ -22,7 +22,7 @@ icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 * `inc_dockerfunctions.sh`
@@ -41,7 +41,7 @@ If DOCKER_HOST is not set then the docker socket is detected from a running dock
 ______________________________________________________________________
 
 CHECK_DOCKER_IO
-v0.1
+v0.2
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_docker_stats.md

@@ -18,7 +18,7 @@ icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker
 
 ## Standalone installation
 
-From this repository ypu need next to this script:
+From this repository you need next to this script:
 
 * `inc_pluginfunctions` shared function for all IML checks written in bash
 * `inc_dockerfunctions.sh`
@@ -37,7 +37,7 @@ If DOCKER_HOST is not set then the docker socket is detected from a running dock
 ______________________________________________________________________
 
 CHECK_DOCKER_STATS
-v1.1
+v1.2
 
 (c) Institute for Medical Education - University of Bern
 Licence: GNU GPL 3

docs/20_Checks/check_dockercontainer_info.md

+## CHECK_DOCKERCONTAINER_INFO
+
+Script: `check_dockercontainer_info`
+
+List existing containers and show container details.
+To show details you can enter an id or define a regex
+
+⚠️ This script is more experimental.
+
+## Requirements
+
+* `docker` Docker must be installed
+* `jq` must be installed - commandline JSON processor
+* `bc` must be installed - an arbitrary precision calculator language
+* sudo permissions on docker command
+
+```txt
+icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker
+```
+
+## Standalone installation
+
+From this repository you need next to this script:
+
+* `inc_pluginfunctions` shared function for all IML checks written in bash
+* `inc_dockerfunctions.sh`
+
+## Rootless docker
+
+It works with docker setups as root and can handle rootless docker instances.
+
+To bring it up and running with an unpriviledged icinga user it must be able to access docker. Copy the docker binary eg. from /home/dockeruser/bin/docker to /usr/bin/. Then use the parameter `-p /usr/bin`.
+
+If DOCKER_HOST is not set then the docker socket is detected from a running docker instance and will be fetched from the process list.
+
+## Syntax
+
+```txt
+______________________________________________________________________
+
+CHECK_DOCKERCONTAINER_INFO
+v1.1
+
+(c) Institute for Medical Education - University of Bern
+Licence: GNU GPL 3
+
+https://os-docs.iml.unibe.ch/icinga-checks/Checks/check_dockercontainer_info.html
+______________________________________________________________________
+
+List existing containers and show container details.
+To show details you can enter an id or define a regex
+
+USAGE:
+  check_dockercontainer_info [OPTIONS]
+
+OPTIONS:
+  -h  Show this help and exit.
+  -s  Show containers using 'docker ps --all' and exit.
+  -i ID
+      Show details for container with given id.
+  -f REGEX
+      Show details for first matching container with given regex in output
+      of 'docker ps --all'.
+
+  If the options -i and -f are used then -i ID has priority.
+
+PARAMETERS:
+  ID     Hexadcimal value for the container id
+  REGEX  String to filter the container list. With it you can set an image 
+         name or a container name.
+
+EXAMPLES:
+  check_dockercontainer_info -s
+      Show all containers 
+
+  check_dockercontainer_info -i 0356f42ed27d
+      Show container details of container with id 0356f42ed27d
+
+  check_dockercontainer_info -f myapp
+      Show container details of first container that matches "myapp" in the
+      output of the container list.
+
+```
+
+### Parameters
+
+None.
+
+## Examples
+
+### Stats
+
+`$ ./check_dockercontaeiner_top` returns
+
+```txt
+TODO
+```