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

update docs

parent b40c4838
No related branches found
No related tags found
1 merge request!230Docker checks
...@@ -9,6 +9,11 @@ This check sends performance data. ...@@ -9,6 +9,11 @@ This check sends performance data.
## Requirements ## Requirements
* `docker` Docker must be installed * `docker` Docker must be installed
* sudo permissions on docker command
```txt
icingaclient ALL=(ALL) NOPASSWD:SETENV: /usr/bin/docker
```
## Syntax ## Syntax
...@@ -16,7 +21,7 @@ This check sends performance data. ...@@ -16,7 +21,7 @@ This check sends performance data.
______________________________________________________________________ ______________________________________________________________________
CHECK_DOCKER_INFO CHECK_DOCKER_INFO
v1.0 v1.1
(c) Institute for Medical Education - University of Bern (c) Institute for Medical Education - University of Bern
Licence: GNU GPL 3 Licence: GNU GPL 3
...@@ -26,14 +31,29 @@ ______________________________________________________________________ ...@@ -26,14 +31,29 @@ ______________________________________________________________________
Show docker version and count of containers total and by its status. Show docker version and count of containers total and by its status.
It returns
CRITICAL if a created container is not running.
OK if no container was created yet or all conmtainers are running
UNKNOWM if
- docker or jq were not found
- docker data were not fetched
- docker cannot be connected
This check provides performance data.
USAGE: USAGE:
check_docker_info [OPTIONS] check_docker_info [OPTIONS]
OPTIONS: OPTIONS:
-h this help -h this help
-d Debug; Flag: show all docker system infos
EXAMPLES: EXAMPLES:
check_docker_info check_docker_info
Show Status of all containers
check_docker_info -d
Show Status of all containers and json with all docker system infos
``` ```
...@@ -50,3 +70,17 @@ OK: Docker 20.10.14 (Community Engine) .. containers: 2 running: 2 paused: 0 sto ...@@ -50,3 +70,17 @@ OK: Docker 20.10.14 (Community Engine) .. containers: 2 running: 2 paused: 0 sto
All containers are running All containers are running
|containers-running=2;;;0;2 containers-paused=0;;;0;2 containers-stopped=0;;;0;2 images=33;; |containers-running=2;;;0;2 containers-paused=0;;;0;2 containers-stopped=0;;;0;2 images=33;;
``` ```
## Troubleshooting
### Missing environment
```txt
sudo: sorry, you are not allowed to preserve the environment
UNKNOWN: No data. Unable to fetch Docker information.
```
Solution: you did not set SETENV in the sudoers config file
icingaclient ALL=(ALL) NOPASSWD:**SETENV:** /usr/bin/docker
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment