You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/operation/docker-tutorial.mdx
+47-12Lines changed: 47 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ title: Docker tutorial
6
6
Deploying Simplicité with Docker images tutorial
7
7
================================================
8
8
9
-
For this tutorial we use an out-of-the-box **AlmaLinux/RockyLinux** (or legacy CentOS 7 or Debian) host but this can be transposed to any other host OS.
9
+
For this tutorial we use an out-of-the-box **AlmaLinux 8, 9 or 10** (or legacy CentOS 7 or Debian) host but this can be transposed to any other host OS.
10
10
11
11
By following the steps below you should have an easily-maintainable **production-grade** deployment of Simplicité up and running **in a few minutes**.
Then the services are to be restarted in the following order:
36
38
@@ -82,10 +84,10 @@ For each logging event, an event **code** is associated, and depending on the co
82
84
83
85
- The `DEBUG` log level is convenient for investigating an issue but **must not** be set by default.
84
86
- The applicative `ERROR` logs (containing the `SIMPLICITE` keyword) usually correspond to normal application
85
-
errors (the only error logs that requires investigation are the one that correspond to a database problem)
87
+
errors (the only error logs that requires investigation are the one that correspond to a database problem)
86
88
- The other error logs needs further investigation in any case.
87
89
- Any log at level `FATAL` generally requires services restart with prior technical investigation
88
-
(typically if the error correspond to a memory or file system issue requires actions at OS level)
90
+
(typically if the error correspond to a memory or file system issue requires actions at OS level)
89
91
90
92
Housekeeping
91
93
------------
@@ -161,8 +163,8 @@ For a given application a comprehensive save consist in:
161
163
162
164
- Saving the database content using an usual database dump tool: `mysqldump`for MySQL or `pgdump`for postgreSQL
163
165
- Saving the documents data directory content located in `$TOMCAT_ROOT/data/simplicite/<my application>/dbdoc`
164
-
(classical packaging) or `$TOMCAT_ROOT/webapps/ROOT/WEB-INF/dbdoc` (instances packaging) or in a custom location depending on your installation)
165
-
using an usual archive tool: `zip` or `tar`
166
+
(classical packaging) or `$TOMCAT_ROOT/webapps/ROOT/WEB-INF/dbdoc` (instances packaging) or in a custom location depending on your installation
167
+
using an usual archive tool: `zip` or `tar`
166
168
167
169
These two operations needs to be done exactly **at the same time** to avoid any data inconsistencies.
168
170
@@ -193,7 +195,7 @@ The typical output for the ping is:
193
195
194
196
The typical output for the health check (in JSON format) is:
195
197
196
-
```json
198
+
```text
197
199
[Platform]
198
200
Status=OK
199
201
Version=<version, e.g. 5.2.19>
@@ -270,7 +272,8 @@ Date=2022-10-17 12:12:31
270
272
ElapsedTime=230
271
273
```
272
274
273
-
If both page/service does not return response or returns a HTTP status different from `200` or if the response value for `status` is not `OK`, something needs to be investigated/fixed.
275
+
If both page/service does not return response or returns a HTTP status different from `200` or if the response value for `status` is not `OK`,
276
+
something needs to be investigated/fixed.
274
277
275
278
System updates
276
279
--------------
@@ -281,15 +284,21 @@ System updates **must** be applied regularly, especially in case of critical sec
281
284
282
285
On Linux CentOS, you can check if there are pending system upgrades packages by:
283
286
284
-
sudo dnfcheck-update
287
+
```shell
288
+
sudo dnfcheck-update
289
+
```
285
290
286
291
You can then apply the updates by:
287
292
288
-
sudo dnf update
293
+
```shell
294
+
sudo dnf update
295
+
```
289
296
290
297
You should then clean up update packages by:
291
298
292
-
sudo dnf clean all
299
+
```shell
300
+
sudo dnf clean all
301
+
```
293
302
294
303
If there is an **JVM** update you must stop the running Tomcat instances prior to the update and restart them after the update.
295
304
@@ -299,8 +308,10 @@ If there is a **kernel** update you must reboot the server after the update.
299
308
300
309
To clean up old kernels you can do:
301
310
302
-
sudo dnf install yum-utils
303
-
sudo package-cleanup --oldkernels --count=2
311
+
```shell
312
+
sudo dnf install yum-utils
313
+
sudo package-cleanup --oldkernels --count=2
314
+
```
304
315
305
316
Tomcat updates
306
317
--------------
@@ -312,9 +323,11 @@ The Tomcat server **must** be updated regularly, depending on the way it has bee
312
323
Platform updates
313
324
----------------
314
325
315
-
> **Note**: this chapter is not applicable when using our Docker images. When using such images the Simplicité platform is always up-to-date in the latest images.
326
+
> **Note**: this chapter is not applicable when using our Docker images. When using such images the Simplicité
327
+
> platform is always up-to-date in the latest images.
316
328
317
-
The Simplicité® platform **must** be updated regularly, at least on its maintenance branch (see [versions](/versions/versioning.md)), depending on the way it has been installed the process may vary.
329
+
The Simplicité® platform **must** be updated regularly, at least on its maintenance branch (see [versions](/versions/versioning.md)),
330
+
depending on the way it has been installed the process may vary.
0 commit comments