Fixes #661 - Added resource limit scenario

Co-authored-by: Martin Gruner <mg@zammad.com>

Author: ralf401

install/docker-compose/docker-compose-scenarios.rst

@@ -31,6 +31,7 @@ The following scenarios are supported and explained further below:
 
   - Disable the backup service
   - Add an Ollama instance to the stack
+  - Limit hardware resources of the stack
 
 You can find the files in the
 `Zammad-Docker-Compose repository <https://github.com/zammad/zammad-docker-compose>`_.
@@ -220,6 +221,15 @@ out of the box.
 To use it in Zammad, add the service name and port (``http://ollama:11434``) to
 the :admin-docs:`provider configuration </ai/provider.html>`.
 
+Limit Resources
+^^^^^^^^^^^^^^^
+
+If you want to limit the hardware resources the Zammad stack is allowed to use,
+use the ``scenarios/apply-resource-limits.yml`` scenario. Default values for CPU
+and memory usage for each container in the stack are applied then. You can find
+these default values in the ``.env.dist`` file. Provide the changed variables
+you want to use as environment variables and deploy the stack.
+
 Other Use Cases
 ^^^^^^^^^^^^^^^
 

install/docker-compose/environment.rst

@@ -35,21 +35,36 @@ Zammad
      - ``(unset)``
      - Allows spawning ``n`` workers to allow more simultaneous connections for
        Zammads web UI. See also: :doc:`/appendix/configure-env-vars`
-   * - | ZAMMAD_SESSION_JOBS
-       | _CONCURRENT
+
+       In case you applied :doc:`docker hardware resource limits </install/docker-compose/docker-compose-scenarios>`,
+       the zammad-railsserver's CPU setting should match the value from this variable.
+   * - | ZAMMAD_PROCESS_SESSION
+       | _JOBS_WORKERS
      - ``(unset)``
-     - Allows spawning ``n`` session job workers to release pressure from
-       Zammads background worker. See also: :doc:`/appendix/configure-env-vars`
+     - Allows spawning ``n`` independent session jobs workers to release
+       pressure from Zammad's background worker. See also:
+       :doc:`/appendix/configure-env-vars`.
+
+       In case you applied :doc:`docker hardware resource limits </install/docker-compose/docker-compose-scenarios>`,
+       the zammad-scheduler CPU setting should match the sum of all worker settings variables.
    * - | ZAMMAD_PROCESS_SCHEDULED
        | _JOBS_WORKERS
      - ``(unset)``
-     - Allows spawning ``1`` independent scheduled job worker to release
-       pressure from Zammads background worker. See also: :doc:`/appendix/configure-env-vars`
+     - Allows spawning ``1`` independent scheduled jobs worker to release
+       pressure from Zammad's background worker. See also:
+       :doc:`/appendix/configure-env-vars`.
+
+       In case you applied :doc:`docker hardware resource limits </install/docker-compose/docker-compose-scenarios>`,
+       the zammad-scheduler CPU setting should match the sum of all worker settings variables.
    * - | ZAMMAD_PROCESS_DELAYED
        | _JOBS_WORKERS
      - ``(unset)``
-     - Allows spawning ``n`` delayed job workers to release pressure from
-       Zammads background worker. See also: :doc:`/appendix/configure-env-vars`
+     - Allows spawning ``n`` delayed jobs workers to release pressure from
+       Zammad's background worker. See also: :doc:`/appendix/configure-env-vars`.
+
+
+       In case you applied :doc:`docker hardware resource limits </install/docker-compose/docker-compose-scenarios>`,
+       the zammad-scheduler CPU setting should match the sum of all worker settings variables.
    * - RAILS_TRUSTED_PROXIES
      - ``['127.0.0.1', '::1']``
      - By default Zammad trusts localhost proxies only.