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

update docs

parent 2b7fa8de
Branches
No related tags found
1 merge request!288OP#7659 Icinga-Check Mysql - Hilfe wird nicht angezeigt https://projects.iml.unibe.ch/work_packages/7659
This commit is part of merge request !288. Comments created here will be created in the context of that merge request.
...@@ -19,7 +19,7 @@ The check returns ...@@ -19,7 +19,7 @@ The check returns
* curl * curl
* Bash REST API client<br>A set of class like functions with a http. prefix. <br>📗 Docs: <https://os-docs.iml.unibe.ch/bash-rest-api-client/> * Bash REST API client<br>A set of class like functions with a http. prefix. <br>📗 Docs: <https://os-docs.iml.unibe.ch/bash-rest-api-client/>
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 `http.class.sh`.
## Standalone installation ## Standalone installation
...@@ -45,7 +45,7 @@ You can use another filename for this configuration - but then you need the para ...@@ -45,7 +45,7 @@ You can use another filename for this configuration - but then you need the para
| -- | -- | -- | | -- | -- | -- |
| GITLAB_API | string | target url to the gitlab api | | GITLAB_API | string | target url to the gitlab api |
| GITLAB_TOKEN | string | token of an admin user to read the api | | GITLAB_TOKEN | string | token of an admin user to read the api |
| REST_CLIENT | string | rest-api-client.sh as filename with full path or relative to the check_gitlab_tokens | | REST_CLIENT | string | http.class.sh as filename with full path or relative to the check_gitlab_tokens |
Example: Example:
...@@ -55,7 +55,7 @@ GITLAB_API='https://gitlab.example.com/api/v4' ...@@ -55,7 +55,7 @@ GITLAB_API='https://gitlab.example.com/api/v4'
GITLAB_TOKEN='glpat-1234567890' GITLAB_TOKEN='glpat-1234567890'
# Rest API client # Rest API client
# REST_CLIENT='/some/where/rest-api-client.sh' # REST_CLIENT='/some/where/http.class.sh'
``` ```
Hint: Hint:
...@@ -103,10 +103,10 @@ OPTIONS: ...@@ -103,10 +103,10 @@ OPTIONS:
GITLAB_API='https://gitlab.example.com/api/v4' GITLAB_API='https://gitlab.example.com/api/v4'
GITLAB_CONFIG=<TOKEN> GITLAB_CONFIG=<TOKEN>
REST_CLIENT="/opt/rest-api-client/rest-api-client.sh" REST_CLIENT="/opt/rest-api-client/http.class.sh"
-r FILE path to REST api client -r FILE path to REST api client
default: /opt/rest-api-client/rest-api-client.sh default: /opt/rest-api-client/http.class.sh
The parameter overrides the variable REST_CLIENT. The parameter overrides the variable REST_CLIENT.
-s DAYS Number of days for max age of token; default: 395 -s DAYS Number of days for max age of token; default: 395
......
...@@ -25,7 +25,6 @@ uid=1041(icingaclient) gid=1041(icingaclient) groups=1041(icingaclient),1031(iml ...@@ -25,7 +25,6 @@ uid=1041(icingaclient) gid=1041(icingaclient) groups=1041(icingaclient),1031(iml
From this repository ypu need next to this script: From this repository ypu need next to this script:
* `inc_pluginfunctions` shared function for all IML checks written in bash * `inc_pluginfunctions` shared function for all IML checks written in bash
* `inc_haproxy_cfg.sh` shared function to parse HA proxy configs
## Syntax ## Syntax
......
...@@ -12,7 +12,7 @@ The kind of check is defined by a parameter `-m METHOD`. ...@@ -12,7 +12,7 @@ The kind of check is defined by a parameter `-m METHOD`.
## Standalone installation ## 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_pluginfunctions` shared function for all IML checks written in bash
...@@ -24,7 +24,7 @@ From this repository ypu need next to this script: ...@@ -24,7 +24,7 @@ From this repository ypu need next to this script:
______________________________________________________________________ ______________________________________________________________________
CHECK_MYSQLSERVER CHECK_MYSQLSERVER
v1.0 v1.2
(c) Institute for Medical Education - University of Bern (c) Institute for Medical Education - University of Bern
Licence: GNU GPL 3 Licence: GNU GPL 3
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment