about summary refs log tree commit diff
path: root/nixos/modules
diff options
context:
space:
mode:
authorRobert Hensing <robert@roberthensing.nl>2021-02-10 09:49:57 +0100
committerRobert Hensing <robert@roberthensing.nl>2021-02-10 09:49:57 +0100
commit0c2295775102edcb4296b5f5a14a5e2b4edf5dee (patch)
treea026cecd290f46ac39233432b18f03e0f8be6bb4 /nixos/modules
parentfbabab7b169dbe5ae9656b6e681b27d4af70931e (diff)
nixos/hercules-ci-agent: Improve concurrentTasks option doc
Diffstat (limited to 'nixos/modules')
-rw-r--r--nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix10
1 files changed, 7 insertions, 3 deletions
diff --git a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
index 522d4ddac317a..3df057b10279e 100644
--- a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
+++ b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
@@ -35,10 +35,14 @@ let
       };
       concurrentTasks = mkOption {
         description = ''
-          Number of tasks to perform simultaneously, such as evaluations, derivations.
+          Number of tasks to perform simultaneously.
 
-          You must have a total capacity across agents of at least 2 concurrent tasks on <literal>x86_64-linux</literal>
-          to allow for import from derivation.
+          A task is a single derivation build or an evaluation.
+          At minimum, you need 2 concurrent tasks for <literal>x86_64-linux</literal>
+          in your cluster, to allow for import from derivation.
+
+          <literal>concurrentTasks</literal> can be around the CPU core count or lower if memory is
+          the bottleneck.
         '';
         type = types.int;
         default = 4;