Skip to content

Commit 278c43f

Browse files
committed
Clarify AgentsPerInstance behavior
Clarify AgentsPerInstance behavior, especially in context of ScaleInIdlePeriod. This should give a better view on what to expect when spawning more than 1 (default) agents per EC2 instance.
1 parent b6a8d40 commit 278c43f

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

templates/aws-stack.yml

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,9 @@ Parameters:
239239
Default: "1"
240240

241241
BuildkiteAgentEnableGracefulShutdown:
242-
Description: Set to true to enable graceful shutdown of agents when the ASG is updated with replacement. This allows ASGs to be removed in a timely manner during an in-place update of the elastic stack, and allows remaining agents to finish jobs without interruptions.
242+
Description: >
243+
Set to true to enable graceful shutdown of agents when the ASG is updated with replacement.
244+
This allows ASGs to be removed in a timely manner during an in-place update of th Elastic Stack, and allows remaining agents to finish jobs without interruptions.
243245
Type: String
244246
AllowedValues:
245247
- "true"
@@ -367,7 +369,9 @@ Parameters:
367369
MinLength: 1
368370

369371
AgentsPerInstance:
370-
Description: Number of Buildkite agents to run on each instance
372+
Description: >
373+
Number of Buildkite agents to run on each instance. This determines the initial count of agents launched when an instance starts.
374+
If an individual agent is terminated (e.g., due to a job failure or manual shutdown), it will not be automatically restarted, resulting in fewer agents on that instance (N-1). The ScaleInIdlePeriod parameter does not affect this agent count.
371375
Type: Number
372376
Default: 1
373377
MinValue: 1
@@ -483,7 +487,10 @@ Parameters:
483487
Default: 1.0
484488

485489
ScaleInIdlePeriod:
486-
Description: Number of seconds an agent must be idle before terminating
490+
Description: >
491+
Number of seconds ALL agents on an instance must be idle before the instance is terminated.
492+
When all AgentsPerInstance agents are idle for this duration, the entire instance is terminated, not individual agents.
493+
This parameter controls instance-level scaling behavior.
487494
Type: Number
488495
Default: 600
489496

0 commit comments

Comments
 (0)