Add scenario to apply docker resource limits (#492)

Author: mgruner

.env.dist

@@ -87,3 +87,31 @@
 #############################################
 
 # OLLAMA_PULL_MODEL=llama3.2
+
+#############################################
+# scenarios/apply-resource-limits.yml
+#############################################
+
+# By loading the scenario, these default limits
+# are applied. Uncomment and change if needed.
+
+# ZAMMAD_BACKUP_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_BACKUP_RESOURCES_LIMITS_MEMORY=500m
+# ZAMMAD_ELASTICSEARCH_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_ELASTICSEARCH_RESOURCES_LIMITS_MEMORY=1G
+# ZAMMAD_INIT_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_INIT_RESOURCES_LIMITS_MEMORY=500M
+# ZAMMAD_MEMCACHED_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_MEMCACHED_RESOURCES_LIMITS_MEMORY=500M
+# ZAMMAD_NGINX_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_NGINX_RESOURCES_LIMITS_MEMORY=500M
+# ZAMMAD_POSTGRESQL_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_POSTGRESQL_RESOURCES_LIMITS_MEMORY=500M
+# ZAMMAD_RAILSSERVER_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_RAILSSERVER_RESOURCES_LIMITS_MEMORY=500M
+# ZAMMAD_REDIS_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_REDIS_RESOURCES_LIMITS_MEMORY=500M
+# ZAMMAD_SCHEDULER_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_SCHEDULER_RESOURCES_LIMITS_MEMORY=500M
+# ZAMMAD_WEBSOCKET_RESOURCES_LIMITS_CPUS=1.0
+# ZAMMAD_WEBSOCKET_RESOURCES_LIMITS_MEMORY=500M

.github/tests/apply-resource-limits.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+# shellcheck source=/dev/null
+. "$(dirname "$0")/include/functions.sh"
+
+check_stack_start

.github/tests/setup/apply-resource-limits.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -o errexit
+
+docker compose -f docker-compose.yml -f scenarios/apply-resource-limits.yml up --pull always --quiet-pull --detach

.github/workflows/ci.yaml

@@ -53,6 +53,7 @@ jobs:
           - add-hostport-to-elasticsearch
           - add-nginx-proxy-manager
           - add-ollama
+          - apply-resource-limits
           - disable-backup-service
           - disable-elasticsearch-service
     steps:

scenarios/apply-resource-limits.yml

@@ -0,0 +1,68 @@
+---
+version: "3.8"
+
+#
+# Apply resource limits to the Zammad services.
+#
+
+services:
+  zammad-backup:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_BACKUP_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_BACKUP_RESOURCES_LIMITS_MEMORY:-500m}"
+  zammad-elasticsearch:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_ELASTICSEARCH_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_ELASTICSEARCH_RESOURCES_LIMITS_MEMORY:-1G}"
+  zammad-init:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_INIT_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_INIT_RESOURCES_LIMITS_MEMORY:-500M}"
+  zammad-memcached:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_MEMCACHED_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_MEMCACHED_RESOURCES_LIMITS_MEMORY:-500M}"
+  zammad-nginx:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_NGINX_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_NGINX_RESOURCES_LIMITS_MEMORY:-500M}"
+  zammad-postgresql:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_POSTGRESQL_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_POSTGRESQL_RESOURCES_LIMITS_MEMORY:-500M}"
+  zammad-railsserver:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_RAILSSERVER_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_RAILSSERVER_RESOURCES_LIMITS_MEMORY:-500M}"
+  zammad-redis:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_REDIS_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_REDIS_RESOURCES_LIMITS_MEMORY:-500M}"
+  zammad-scheduler:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_SCHEDULER_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_SCHEDULER_RESOURCES_LIMITS_MEMORY:-500M}"
+  zammad-websocket:
+    deploy:
+      resources:
+        limits:
+          cpus: "${ZAMMAD_WEBSOCKET_RESOURCES_LIMITS_CPUS:-1.0}"
+          memory: "${ZAMMAD_WEBSOCKET_RESOURCES_LIMITS_MEMORY:-500M}"