17705: Mention IdleBehavior tag name.
authorTom Clegg <tom@curii.com>
Wed, 9 Jun 2021 13:06:45 +0000 (09:06 -0400)
committerPeter Amstutz <peter.amstutz@curii.com>
Thu, 8 Jul 2021 19:53:00 +0000 (15:53 -0400)
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

doc/architecture/dispatchcloud.html.textile.liquid

index cc7cb24f6c2ee8e6fb1cf1e66c87c994b56261f1..c0a5c26e227bb11f948af8f7d196d774826c786d 100644 (file)
@@ -74,7 +74,7 @@ h2. Automatic instance shutdown
 
 Normally, the dispatcher shuts down any instance that has remained idle for 1 minute (see TimeoutIdle configuration) but there are some exceptions to this rule. If the cloud provider returns a quota error when trying to create a new instance, the dispatcher shuts down idle nodes right away, in case the idle nodes are contributing to the quota. Also, the operator can use the management API to set an instance’s idle behavior to “drain” or “hold”. “Drain” shuts down the instance as soon as it becomes idle, which can be used to recycle a suspect node without interrupting a running container. “Hold” keeps the instance alive indefinitely without scheduling additional containers on it, which can be used to investigate problems like a failed startup script.
 
-Each instance is tagged with its current idle behavior, which makes it visible in the cloud provider’s console and ensures the behavior is retained if dispatcher restarts.
+Each instance is tagged with its current idle behavior (using the tag name “IdleBehavior”), which makes it visible in the cloud provider’s console and ensures the behavior is retained if dispatcher restarts.
 
 h2. Management API