From 653f6cd7e33a9c132d625c406cf406be69fd8f40 Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch>
Date: Mon, 25 Apr 2022 18:59:21 +0200
Subject: [PATCH] update docs
---
docs/40_Usage.md | 12 ++++++++++++
docs/_index.md | 12 ++++++------
2 files changed, 18 insertions(+), 6 deletions(-)
diff --git a/docs/40_Usage.md b/docs/40_Usage.md
index 6ae41b3..506f428 100644
--- a/docs/40_Usage.md
+++ b/docs/40_Usage.md
@@ -37,6 +37,18 @@ You can add an existing profile name to limit the execution to that profile only
To start a single profile start `./deploy_app.sh -l` to get a list of exisring configured profiles
and then `./deploy_app.sh [PROFILE]`.
+Each execution on CLI or cronjob creates a log file per profile in /var/log/imldeployment-client/.
+
+```text
+> ls -ltr /var/log/imldeployment-client/
+total 60
+-rw-r--r-- 1 root root 28613 Apr 25 15:09 profile_A__2022-04-25__150405.log
+-rw-r--r-- 1 root root 30747 Apr 25 15:10 profile_B__2022-04-25__150959.log
+```
+
+Each logfile contens the profile name + 2 underscore + timestamp.
+There is an automatic cleanup: the script keeps the last 10 logs per profile.
+
## ./bin/create_config.sh
The script is used to read a template (*.erb) to replace simple placeholders
diff --git a/docs/_index.md b/docs/_index.md
index eb9bcbd..534b246 100644
--- a/docs/_index.md
+++ b/docs/_index.md
@@ -5,20 +5,20 @@ It handles a secure download, extracts the package, generates configs.
```mermaid
graph LR
- CI(CI deployment web gui ) --> |Build package| PkgDir
+ CI(CI<br>deployment<br>web gui) --> |Build| PkgDir
+ PkgDir[Package<br>dir]
- PkgDir[Package dir]
PkgDir --> |rsync| Pkg1
PkgDir --> |rsync| Pkg2
PkgDir --> |rsync| Pkg3
- Pkg1(CI package server 1) --> |secure download| DeployClient
- Pkg2(CI package server N)
+ Pkg1(CI package<br>server 1) --> |secure<br>download| DeployClient
+ Pkg2(CI package<br>server N)
Pkg3(Puppet master)
subgraph Appserver
- DeployClient --> |installs| ApplicationA(Application A)
- DeployClient --> |installs| ApplicationB(Application B)
+ DeployClient --> |installs| ApplicationA(Application A)
+ DeployClient --> |installs| ApplicationB(Application B)
end
```
--
GitLab