From 67b9bfc299ad43dd67071a19782560f9df859418 Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch>
Date: Mon, 9 Dec 2024 18:35:54 +0100
Subject: [PATCH] update docs
---
docs/20_Checks/check_gitlab_tokens.md | 10 +++++-----
docs/20_Checks/check_iml_backup_server.md | 1 -
docs/20_Checks/check_mysqlserver.md | 4 ++--
3 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/docs/20_Checks/check_gitlab_tokens.md b/docs/20_Checks/check_gitlab_tokens.md
index a5162e5..8a4aac4 100644
--- a/docs/20_Checks/check_gitlab_tokens.md
+++ b/docs/20_Checks/check_gitlab_tokens.md
@@ -19,7 +19,7 @@ The check returns
* 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/>
-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
@@ -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_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:
@@ -55,7 +55,7 @@ GITLAB_API='https://gitlab.example.com/api/v4'
GITLAB_TOKEN='glpat-1234567890'
# Rest API client
-# REST_CLIENT='/some/where/rest-api-client.sh'
+# REST_CLIENT='/some/where/http.class.sh'
```
Hint:
@@ -103,10 +103,10 @@ OPTIONS:
GITLAB_API='https://gitlab.example.com/api/v4'
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
- default: /opt/rest-api-client/rest-api-client.sh
+ default: /opt/rest-api-client/http.class.sh
The parameter overrides the variable REST_CLIENT.
-s DAYS Number of days for max age of token; default: 395
diff --git a/docs/20_Checks/check_iml_backup_server.md b/docs/20_Checks/check_iml_backup_server.md
index 7ae3e2d..ae7b239 100644
--- a/docs/20_Checks/check_iml_backup_server.md
+++ b/docs/20_Checks/check_iml_backup_server.md
@@ -25,7 +25,6 @@ uid=1041(icingaclient) gid=1041(icingaclient) groups=1041(icingaclient),1031(iml
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
diff --git a/docs/20_Checks/check_mysqlserver.md b/docs/20_Checks/check_mysqlserver.md
index 4b9513f..c0c144a 100644
--- a/docs/20_Checks/check_mysqlserver.md
+++ b/docs/20_Checks/check_mysqlserver.md
@@ -12,7 +12,7 @@ The kind of check is defined by a parameter `-m METHOD`.
## 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
@@ -24,7 +24,7 @@ From this repository ypu need next to this script:
______________________________________________________________________
CHECK_MYSQLSERVER
-v1.0
+v1.2
(c) Institute for Medical Education - University of Bern
Licence: GNU GPL 3
--
GitLab