You are viewing documentation for version 1.14.x. The most current version is 1.19.x.  This documentation is available for 1.19.x.

ecs

Settings related to Amazon ECS (settings.ecs.*)

Topic list

Setting list for settings.ecs


Topics

Log Settings

Settings related to logs from the ECS Agent

Settings

Startup Only Settings

These settings affect how the instances join the ECS cluster. Since joining a cluster happens at startup, they need to be set in user data.

Settings


Full Reference

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

Also see: 

settings.ecs.cluster

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

Also see: 

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).

Also see: 

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

Also see: 

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).

Also see: 

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

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

Also see: 

settings.ecs.image-cleanup-enabled

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

Default: true

Also see: 

settings.ecs.image-pull-behavior

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

Default: default

Accepted values:
  • default
  • always
  • once
  • prefer-cached
Also see: 

settings.ecs.instance-attributes

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

# Example user data for setting up attributes
[settings.ecs.instance-attributes]
attribute1 = foo
attribute2 = bar
Example user data for setting up attributes
apiclient set settings.ecs.instance-attributes.attribute1=foo \ 
 	settings.ecs.instance-attributes.attribute2=bar
Also see: 

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.

Also see: 

settings.ecs.loglevel

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

Default: info

Accepted values:
  • debug
  • info
  • warn
  • error
  • crit
Also see: 

settings.ecs.metadata-service-burst

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

Also see: 

settings.ecs.metadata-service-rps

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

Also see: 

settings.ecs.reserved-memory

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

settings.ecs.task-cleanup-wait

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

Also see: