ecs

settings.ecs.allow-privileged-containers

Allow the launch of privileged containers on the container instance. If this value is set to false, privileged containers are not permitted.

Default: false

• ECS_DISABLE_PRIVILEGED in the ECS Agent Environment Variables

settings.ecs.awsvpc-block-imds

Blocks access to Instance Metadata for Tasks started with awsvpc network mode if true

Default: false

• ECS_AWSVPC_BLOCK_IMDS in the ECS Agent Environment Variables

settings.ecs.backend-host

Sets the endpoint to make calls against (e.g ecs.us-east-1.amazonaws.com).

Default: The endpoint for your current region.

settings.ecs.cluster

The name or ARN of your Amazon ECS cluster. If left unspecified, the Bottlerocket host will join your default cluster.

• Startup Only Settings

settings.ecs.container-stop-timeout

Time to wait for the task’s containers to stop on their own before they are forcefully stopped. Valid time units include s, m, and h (e.g. 1h, 1m1s).

Default: 30s

• ECS_CONTAINER_STOP_TIMEOUT in the ECS Agent Environment Variables

settings.ecs.enable-container-metadata

When true, the agent will create a file describing the container’s metadata at the path stored in the environment variable ECS_CONTAINER_METADATA_FILE

Default: false

• ECS_ENABLE_CONTAINER_METADATA in the ECS Agent Environment Variables

settings.ecs.enable-spot-instance-draining

If the instance receives a spot termination notice, the agent will set the instance’s state to DRAINING, so the workload can be moved gracefully before the instance is removed.

Default: false

• ECS_ENABLE_SPOT_INSTANCE_DRAINING in the ECS Agent Environment Variables

settings.ecs.image-cleanup-age

Time since the image was pulled to be considered for clean up. Valid time units include s, m, and h (e.g. 1h, 1m1s).

• Image & Task Cleanup Settings

settings.ecs.image-cleanup-delete-per-cycle

Number of images to delete in a single image cleanup cycle.

• Image & Task Cleanup Settings
• ECS_NUM_IMAGES_DELETE_PER_CYCLE in the ECS Agent Environment Variables

settings.ecs.image-cleanup-enabled

Enable automatic images clean up after the tasks have been removed.

Default: true

• Image & Task Cleanup Settings
• ECS_DISABLE_IMAGE_CLEANUP in the ECS Agent Environment Variables

settings.ecs.image-cleanup-wait

Time to wait between image cleanup cycles Valid time units include s, m, and h (e.g. 1h, 1m1s).

• Image & Task Cleanup Settings

settings.ecs.image-pull-behavior

The behavior used to customize the pull image process for your container instances.

Default: default

• default
• always
• once
• prefer-cached

• ECS_IMAGE_PULL_BEHAVIOR in the ECS Agent Environment Variables

settings.ecs.instance-attributes

Attributes in the form of key, value pairs added when registering the container instance in the cluster.

• TOML
• apiclient

# Example user data for setting up attributes
[settings.ecs.instance-attributes]
attribute1 = foo
attribute2 = bar

apiclient set settings.ecs.instance-attributes.attribute1=foo \ 
 	settings.ecs.instance-attributes.attribute2=bar

• Startup Only Settings
• ECS_INSTANCE_ATTRIBUTES in the ECS Agent Environment Variables

settings.ecs.logging-drivers

The list of logging drivers available on the container instance. The ECS agent running on a container instance must register available logging drivers before tasks that use those drivers are eligible to be placed on the instance. Bottlerocket enables the json-file, awslogs, and none drivers by default.

• Log Settings
• ECS_AVAILABLE_LOGGING_DRIVERS in the ECS Agent Environment Variables

settings.ecs.loglevel

The level of verbosity for the ECS agent’s logs.

Default: info

• debug
• info
• warn
• error
• crit

• Log Settings
• ECS_LOGLEVEL in the ECS Agent Environment Variables

settings.ecs.metadata-service-burst

The burst rate limit of the throttling configurations set for the task metadata service.

• ECS_TASK_METADATA_RPS_LIMIT in the ECS Agent Environment Variables

settings.ecs.metadata-service-rps

The steady state rate limit of the throttling configurations set for the task metadata service.

• ECS_TASK_METADATA_RPS_LIMIT in the ECS Agent Environment Variables

settings.ecs.reserved-memory

The amount of memory, in MiB, reserved for critical system processes.

settings.ecs.task-cleanup-wait

Time to wait before the task’s containers are removed after they are stopped. Valid time units include s, m, and h (e.g. 1h, 1m1s).

• Image & Task Cleanup Settings