[pve-devel] [PATCH docs 1/1] pveproxy, pvedaemon: document MAX_WORKERS setting

[Friedrich Weber]

For pveproxy, add it to the description of settings that can be
adjusted in /etc/default/pveproxy.

For pvedaemon, this is currently the only setting that can be adjusted
in /etc/default/pvedaemon.

Signed-off-by: Friedrich Weber <f.weber at proxmox.com>
---
 pvedaemon.adoc | 17 +++++++++++++++++
 pveproxy.adoc  | 18 ++++++++++++++++++
 2 files changed, 35 insertions(+)

diff --git a/pvedaemon.adoc b/pvedaemon.adoc
index 66c751a..d1923a4 100644
--- a/pvedaemon.adoc
+++ b/pvedaemon.adoc
@@ -30,6 +30,23 @@ NOTE: The daemon listens to a local address only, so you cannot access
 it from outside. The `pveproxy` daemon exposes the API to the outside
 world.
 
+[[pvedaemon_max_workers]]
+Number of Workers
+-----------------
+
+`pvedaemon` delegates handling of incoming requests to worker processes. By
+default, `pvedaemon` spawns 3 worker processes, which is sufficient for most
+workloads. For automation-heavy workloads that issue a huge volume of API
+requests and that experience slow request handling or timeouts, the number of
+worker processes can be increased by setting `MAX_WORKERS` in
+`/etc/default/pvedaemon`, for example:
+
+ MAX_WORKERS=5
+
+Note that a higher number of worker processes may result in higher CPU usage.
+The number of worker processes must be greater than 0 and smaller than 128.
+
+The same setting exists for xref:pveproxy_max_workers[pveproxy].
 
 ifdef::manvolnum[]
 include::pve-copyright.adoc[]
diff --git a/pveproxy.adoc b/pveproxy.adoc
index a311afd..6999b4e 100644
--- a/pveproxy.adoc
+++ b/pveproxy.adoc
@@ -227,6 +227,24 @@ IP addresses can be specified using any syntax understood by `Net::IP`. The
 name `all` is an alias for `0/0` and `::/0` (meaning all IPv4 and IPv6
 addresses).
 
+[[pveproxy_max_workers]]
+Number of Workers
+-----------------
+
+`pveproxy` delegates handling of incoming requests to worker processes. By
+default, `pveproxy` spawns 3 worker processes, which is sufficient for most
+workloads. For automation-heavy workloads that issue a huge volume of API
+requests and that experience slow request handling or timeouts, the number of
+worker processes can be increased by setting `MAX_WORKERS` in
+`/etc/default/pveproxy`, for example:
+
+ MAX_WORKERS=5
+
+Note that a higher number of worker processes may result in higher CPU usage.
+The number of worker processes must be greater than 0 and smaller than 128.
+
+The same setting exists for xref:pvedaemon_max_workers[pvedaemon].
+
 ifdef::manvolnum[]
 include::pve-copyright.adoc[]
 endif::manvolnum[]
-- 
2.47.2