You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Use these tags in pipeline steps with 'agents: { environment: production }'.
218
218
Type: String
@@ -227,8 +227,8 @@ Parameters:
227
227
Default: "false"
228
228
229
229
BuildkiteAgentExperiments:
230
-
Description: >
231
-
Optional - Agent experiments to enable, comma delimited.
230
+
Description: >
231
+
Optional - Agent experiments to enable, comma delimited.
232
232
See https://github.com/buildkite/agent/blob/-/EXPERIMENTS.md.
233
233
Type: String
234
234
Default: ""
@@ -247,7 +247,7 @@ Parameters:
247
247
248
248
ScalerEnableExperimentalElasticCIMode:
249
249
Description: >
250
-
Experimental - Enable the Elastic CI Mode with enhanced features like graceful termination and dangling instance detection.
250
+
Experimental - Enable the Elastic CI Mode with enhanced features like graceful termination and dangling instance detection.
251
251
Available since BuildkiteAgentScalerVersion 1.9.3
252
252
Type: String
253
253
AllowedValues:
@@ -309,9 +309,9 @@ Parameters:
309
309
Default: "false"
310
310
AllowedValues: ["true", "false"]
311
311
Description: >
312
-
Enable automatic deletion of old EC2 logs to reduce CloudWatch storage costs.
313
-
Disabled by default to preserve all logs. When enabled, EC2 logs older than EC2LogRetentionDays will be automatically deleted.
314
-
This only affects EC2 instance logs (agents, system logs), not Lambda logs.
312
+
Enable automatic deletion of old EC2 logs to reduce CloudWatch storage costs.
313
+
Disabled by default to preserve all logs. When enabled, EC2 logs older than EC2LogRetentionDays will be automatically deleted.
314
+
This only affects EC2 instance logs (agents, system logs), not Lambda logs.
315
315
WARNING: Enabling this on existing stacks will delete historical logs older than the retention period - this cannot be undone.
316
316
317
317
EC2LogRetentionDays:
@@ -352,8 +352,8 @@ Parameters:
352
352
MinValue: 1
353
353
354
354
BuildkiteAgentSignalGracePeriod:
355
-
Description: >
356
-
The number of seconds given to a subprocess to handle being sent `cancel-signal`.
355
+
Description: >
356
+
The number of seconds given to a subprocess to handle being sent `cancel-signal`.
357
357
After this period has elapsed, SIGKILL will be sent.
358
358
Type: Number
359
359
Default: -1
@@ -457,16 +457,16 @@ Parameters:
457
457
MaxValue: 10000
458
458
459
459
BuildkiteAdditionalSudoPermissions:
460
-
Description: >
461
-
Optional - Comma-separated list of specific commands (full paths) that build jobs can run with sudo privileges.
460
+
Description: >
461
+
Optional - Comma-separated list of specific commands (full paths) that build jobs can run with sudo privileges.
462
462
Include only commands essential for builds. Leave blank unless builds require specific system-level operations.
463
463
Type: String
464
464
Default: ""
465
465
466
466
BuildkiteWindowsAdministrator:
467
-
Description: >
468
-
Add buildkite-agent user to Windows Administrators group.
469
-
This provides full system access for build jobs.
467
+
Description: >
468
+
Add buildkite-agent user to Windows Administrators group.
469
+
This provides full system access for build jobs.
470
470
Set to 'false' if builds don't require administrator privileges for additional security isolation.
471
471
Type: String
472
472
AllowedValues:
@@ -482,9 +482,9 @@ Parameters:
482
482
483
483
AgentsPerInstance:
484
484
Description: >
485
-
Number of Buildkite agents to start on each EC2 instance.
486
-
NOTE: If an agent crashes or is terminated, it won't be automatically restarted, leaving fewer active agents on that instance.
487
-
The ScaleInIdlePeriod parameter controls when the entire instance terminates (when all agents are idle), not individual agent restarts.
485
+
Number of Buildkite agents to start on each EC2 instance.
486
+
NOTE: If an agent crashes or is terminated, it won't be automatically restarted, leaving fewer active agents on that instance.
487
+
The ScaleInIdlePeriod parameter controls when the entire instance terminates (when all agents are idle), not individual agent restarts.
488
488
Consider enabling ScalerEnableExperimentalElasticCIMode for better agent management, or use fewer agents per instance with more instances for high availability.
489
489
Type: Number
490
490
Default: 1
@@ -538,8 +538,8 @@ Parameters:
538
538
539
539
AgentEnvFileUrl:
540
540
Description: >
541
-
Optional - HTTPS or S3 URL containing environment variables for the Buildkite agent process itself (not for builds).
542
-
These variables configure agent behavior like proxy settings or debugging options.
541
+
Optional - HTTPS or S3 URL containing environment variables for the Buildkite agent process itself (not for builds).
542
+
These variables configure agent behavior like proxy settings or debugging options.
543
543
For build environment variables, use pipeline 'env' configuration instead.
544
544
Type: String
545
545
Default: ""
@@ -566,9 +566,9 @@ Parameters:
566
566
567
567
InstanceTypes:
568
568
Description: >
569
-
EC2 instance types to use (comma-separated, up to 25).
569
+
EC2 instance types to use (comma-separated, up to 25).
570
570
The first type listed is preferred for OnDemand instances.
571
-
Additional types improve Spot instance availability but make costs less predictable.
571
+
Additional types improve Spot instance availability but make costs less predictable.
572
572
Examples: 't3.large' for light workloads, 'm5.xlarge,m5a.xlarge' for CPU-intensive builds, 'c5.2xlarge,c5.4xlarge' for compute-heavy tasks.
573
573
Type: String
574
574
Default: "t3.large"
@@ -603,7 +603,7 @@ Parameters:
603
603
604
604
ScalerEventSchedulePeriod:
605
605
Description: >
606
-
How often the Event Schedule for buildkite-agent-scaler is triggered.
606
+
How often the Event Schedule for buildkite-agent-scaler is triggered.
607
607
Should be an expression with units. Example: '30 seconds', '1 minute', '5 minutes'.
608
608
Type: String
609
609
Default: "1 minute"
@@ -616,7 +616,7 @@ Parameters:
616
616
617
617
OnDemandBaseCapacity:
618
618
Description: >
619
-
Specify how much On-Demand capacity the Auto Scaling group should have for its base portion before scaling by percentages.
619
+
Specify how much On-Demand capacity the Auto Scaling group should have for its base portion before scaling by percentages.
620
620
The maximum group size will be increased (but not decreased) to this value.
621
621
Type: Number
622
622
Default: 0
@@ -634,11 +634,11 @@ Parameters:
634
634
MaxValue: 100
635
635
636
636
SpotAllocationStrategy:
637
-
Description: >
638
-
Strategy for selecting Spot instance types to minimize interruptions and costs.
639
-
'capacity-optimized' (recommended) chooses types with the most available capacity.
640
-
'price-capacity-optimized' balances low prices with availability.
641
-
'lowest-price' prioritizes cost savings.
637
+
Description: >
638
+
Strategy for selecting Spot instance types to minimize interruptions and costs.
639
+
'capacity-optimized' (recommended) chooses types with the most available capacity.
640
+
'price-capacity-optimized' balances low prices with availability.
641
+
'lowest-price' prioritizes cost savings.
642
642
'capacity-optimized-prioritized' follows InstanceTypes order while optimizing for capacity.
643
643
Type: String
644
644
Default: "capacity-optimized"
@@ -649,9 +649,9 @@ Parameters:
649
649
- capacity-optimized-prioritized
650
650
651
651
ScaleOutFactor:
652
-
Description: >
653
-
Multiplier for scale-out speed.
654
-
Values higher than 1.0 create instances more aggressively, values lower than 1.0 more conservatively.
652
+
Description: >
653
+
Multiplier for scale-out speed.
654
+
Values higher than 1.0 create instances more aggressively, values lower than 1.0 more conservatively.
655
655
Use higher values for time-sensitive workloads, lower values to control costs.
656
656
Type: Number
657
657
Default: 1.0
@@ -739,8 +739,8 @@ Parameters:
739
739
IMDSv2Tokens:
740
740
Type: String
741
741
Description: >
742
-
Security setting for EC2 instance metadata access.
743
-
'Required' enforces secure token-based access (recommended for security), 'Optional' allows both secure and legacy access methods.
742
+
Security setting for EC2 instance metadata access.
743
+
'Required' enforces secure token-based access (recommended for security), 'Optional' allows both secure and legacy access methods.
744
744
Use 'Required' unless legacy applications require the older metadata service.
745
745
AllowedValues:
746
746
- optional
@@ -759,8 +759,8 @@ Parameters:
759
759
760
760
InstanceRoleTags:
761
761
Description: >
762
-
Optional - Comma-separated key=value pairs for instance IAM role tags (up to 5 tags).
The '-pullthrough' variants (e.g., 'readonly-pullthrough') add permissions to enable automatic caching of public Docker images, reducing pull times and bandwidth costs.
783
783
AllowedValues:
784
784
- none
@@ -792,7 +792,7 @@ Parameters:
792
792
AssociatePublicIpAddress:
793
793
Type: String
794
794
Description: >
795
-
Give instances public IP addresses for direct internet access.
795
+
Give instances public IP addresses for direct internet access.
796
796
Set to 'false' for a more isolated environment if the VPC has alternative outbound internet access configured.
797
797
AllowedValues:
798
798
- "true"
@@ -801,8 +801,8 @@ Parameters:
801
801
802
802
DockerNetworkingProtocol:
803
803
Type: String
804
-
Description: >
805
-
Which IP version to enable for docker containers and building docker images.
804
+
Description: >
805
+
Which IP version to enable for docker containers and building docker images.
806
806
Only applies to Linux instances, not Windows.
807
807
AllowedValues:
808
808
- "ipv4"
@@ -877,9 +877,9 @@ Parameters:
877
877
878
878
MountTmpfsAtTmp:
879
879
Type: String
880
-
Description: >
881
-
Controls the filesystem mounted at /tmp.
882
-
By default, /tmp is a tmpfs (memory-backed filesystem).
880
+
Description: >
881
+
Controls the filesystem mounted at /tmp.
882
+
By default, /tmp is a tmpfs (memory-backed filesystem).
883
883
Disabling this causes /tmp to be stored in the root filesystem.
0 commit comments