From f4bd850b58cf8977960e3d18ced17fa1dd842747 Mon Sep 17 00:00:00 2001 From: Tom Clegg Date: Thu, 23 Dec 2021 16:51:06 -0500 Subject: [PATCH] 18562: Update doc and config comments for UsePreemptibleInstances. Arvados-DCO-1.1-Signed-off-by: Tom Clegg --- doc/admin/spot-instances.html.textile.liquid | 2 +- lib/config/config.default.yml | 10 +++++++++- lib/config/generated_config.go | 10 +++++++++- 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/doc/admin/spot-instances.html.textile.liquid b/doc/admin/spot-instances.html.textile.liquid index 07b7215029..5d4b677413 100644 --- a/doc/admin/spot-instances.html.textile.liquid +++ b/doc/admin/spot-instances.html.textile.liquid @@ -16,7 +16,7 @@ Currently Arvados supports preemptible instances using AWS and Azure spot instan h2. Configuration -To use preemptible instances, set @UsePreemptibleInstances: true@ and add entries to @InstanceTypes@ with @Preemptible: true@ to @config.yml@. Typically you want to add both preemptible and non-preemptible entries for each cloud provider VM type. The @Price@ for preemptible instances is the maximum bid price, the actual price paid is dynamic and will likely be lower. For example: +To use preemptible instances, ensure they are not disabled in your configuration file (they are enabled by default, but can be disabled with @UsePreemptibleInstances: false@), and add entries to @InstanceTypes@ that have @Preemptible: true@. Typically you want to add both preemptible and non-preemptible entries for each cloud provider VM type. The @Price@ for preemptible instances is the maximum bid price, the actual price paid is dynamic and will likely be lower. For example: 
 Clusters:
diff --git a/lib/config/config.default.yml b/lib/config/config.default.yml
index 98437e7758..87d38ffe4b 100644
--- a/lib/config/config.default.yml
+++ b/lib/config/config.default.yml
@@ -902,8 +902,16 @@ Clusters:
       # Schedule all child containers on preemptible instances (e.g. AWS
       # Spot Instances) even if not requested by the submitter.
       #
+      # If false, containers are scheduled on preemptible instances
+      # only when requested by the submitter.
+      #
+      # Note that arvados-cwl-runner does not currently offer a
+      # feature to request preemptible instances, so this value
+      # effectively acts as a cluster-wide decision about whether to
+      # use preemptible instances.
+      #
       # This flag is ignored if no preemptible instance types are
-      # configured.
+      # configured, and has no effect on top-level containers.
       UsePreemptibleInstances: true
 
       # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
diff --git a/lib/config/generated_config.go b/lib/config/generated_config.go
index 751df894e8..4187717f8d 100644
--- a/lib/config/generated_config.go
+++ b/lib/config/generated_config.go
@@ -908,8 +908,16 @@ Clusters:
       # Schedule all child containers on preemptible instances (e.g. AWS
       # Spot Instances) even if not requested by the submitter.
       #
+      # If false, containers are scheduled on preemptible instances
+      # only when requested by the submitter.
+      #
+      # Note that arvados-cwl-runner does not currently offer a
+      # feature to request preemptible instances, so this value
+      # effectively acts as a cluster-wide decision about whether to
+      # use preemptible instances.
+      #
       # This flag is ignored if no preemptible instance types are
-      # configured.
+      # configured, and has no effect on top-level containers.
       UsePreemptibleInstances: true
 
       # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
-- 
2.30.2