18562: Update doc and config comments for UsePreemptibleInstances.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

diff --git a/doc/admin/spot-instances.html.textile.liquid b/doc/admin/spot-instances.html.textile.liquid
index 07b72150295c5bb7ea34eea1bc36e379e956d3e8..5d4b677413472cc3ea6a24b3e6b4028d0ce6dbd6 100644 (file)
--- 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:
 
 <pre>
 Clusters:

diff --git a/lib/config/config.default.yml b/lib/config/config.default.yml
index 98437e77584a525337c51076d7f0402e89748484..87d38ffe4bd380d3d98c37f9a0a2c0861a82850f 100644 (file)
--- 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 751df894e81994b0f8812f21b7bcb5b8e0d0dfe9..4187717f8db94b9587d71ac14b3631656886ee9f 100644 (file)
--- 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