WIP

Author: richturner

docs/developer-guide/licensing-guidelines-for-contributors.md

@@ -13,7 +13,7 @@ Tip: use `./gradlew dependencies` on projects that use gradle as build tool.
 In all source files (except where not appropriate such as property files or test fixtures), include a copyright header:
 
 ```
-Copyright ${YEAR}, OpenRemote Inc.
+Copyright <YEAR>, OpenRemote Inc.
 
 See the CONTRIBUTORS.txt file in the distribution for a
 full listing of individual contributors.

docs/developer-guide/system-administration.md

@@ -75,7 +75,7 @@ GCT: Total garbage collection time.
 Force garbage collection with: 
 
 ```shell
-docker exec -it openremote_manager_1 /usr/bin/jcmd 1 GC.run
+docker exec -it or-manager-1 /usr/bin/jcmd 1 GC.run
 ```
 
 ### Install the JDK
@@ -209,26 +209,28 @@ To keep the instance healthy and prevent Docker crashes, you can follow these gu
 7. Set `effective_cache_size` (P - `shared_buffers`) = 1.5GB
 8. Actively monitor `pg_hot_update_percent` metric to attain a >90% HOT update percentage; tweak the asset table `fillfactor` to achieve this (default is set to: 90% as asset table is not significantly large)
 
-Apply this config in docker compose yaml as follows:
+Apply this config in docker compose yaml as follows (use environment variables for convenience:
 ```yaml
 services:
   postgresql:
-    image: openremote/postgresql:latest
-    shm_size: 1gb 
+    image: openremote/postgresql:${POSTGRESQL_VERSION:-latest-slim}
+    restart: always
+    # RAM limits and PostgreSQL memory settings should be set appropriately for the expected load (see documentation)
+    shm_size: ${OR_DB_SHM:-156mb}
     deploy:
       resources:
         limits:
-          memory: 2G
+          memory: ${OR_DB_RAM:-512M}
     command:
       - postgres
       - -c
-      - shared_buffers=512MB
+      - shared_buffers=${OR_DB_SHARED_BUFFERS:-128MB}
       - -c
-      - effective_cache_size=1536MB
+      - effective_cache_size=${OR_DB_CACHE_SIZE:-384MB}
       - -c
-      - maintenance_work_mem=256MB
+      - maintenance_work_mem=${OR_DB_MAINTENANCE_WORK_MEM:-56MB}
       - -c
-      - work_mem=16MB
+      - work_mem=${OR_DB_WORK_MEM:-4MB}
 ```
 
 #### Some simple guidelines

docs/user-guide/metrics.md

@@ -28,7 +28,7 @@ graph LR
         subgraph Docker [Docker Containers]
             direction TB
             HAProxy["<b>HA Proxy</b><br/>http://localhost:8404/metrics<br/>- Uses prometheus-exporter<br/>- Runs on own embedded web server port 8404<br/>- Configured via haproxy.cfg"]:::greenStyle
-            Manager["<b>Manager</b><br/>http://localhost:8405/metrics<br/>- Micrometer with Prometheus Registry<br/>- Runs on own embedded web server port 8404<br/>- OR_METRICS_ENABLED: true/false"]:::greenStyle
+            Manager["<b>Manager</b><br/>http://localhost:8405/metrics<br/>- Micrometer with Prometheus Registry<br/>- Runs on own embedded web server port 8404 but mapped to 8405 by default<br/>- OR_METRICS_ENABLED: true/false"]:::greenStyle
             Keycloak["<b>Keycloak</b><br/>http://localhost:8080/metrics<br/>- Built in prometheus metrics support<br/>- KC_METRICS_ENABLED: true/false<br/>- Do not publicly expose"]:::orangeStyle
             PostgreSQL["<b>PostgreSQL</b><br/>http://localhost:8406/metrics<br/>- Uses separate query-exporter docker container and config"]:::redStyle
         end
@@ -37,7 +37,7 @@ graph LR
     %% Connections
     PromScrape --> Manager
     PromScrape --> HAProxy
-    PromScape --> PostgreSQL
+    PromScrape --> PostgreSQL
     CWAgent --> CW
     CW --> DB