Skip to content

Commit e119880

Browse files
committed
metadata for v0.1.0
- Add CHANGELOG.md with v0.1.0 entry - Update bottlerocket-ecs-updater.yaml with a default container image
1 parent 99efa68 commit e119880

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# 0.1.0
2+
3+
Initial release of the **Bottlerocket ECS updater** - A service to automatically manage Bottlerocket updates in an Amazon ECS cluster.
4+
5+
The Bottlerocket ECS updater is designed to help you safely automate the routine maintenance of updating the Bottlerocket instances in your cluster.
6+
The updater's safety features include:
7+
8+
* Only tasks that are part of a [service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) will be interrupted.
9+
Container instances with non-service tasks are skipped for upgrade so no critical workloads will be automatically interrupted.
10+
* Only container instances in the [ACTIVE state](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html) will be upgrade.
11+
Instances that have been placed into the DRAINING state are skipped for upgrade so other maintenance or debugging can be performed without interruption.
12+
13+
In this first release of the updater, the following considerations should be kept in mind:
14+
15+
* Only clusters of up to 50 container instances are supported.
16+
If the updater is configured to target a cluster with more than 50 instances, some instances may not be updated.
17+
* When configuring the provided CloudFormation template, ensure that the CloudWatch log group already exists.
18+
The updater will not automatically create the log group and a missing log group will cause the updater to fail to run.
19+
When creating a log group, you can configure your desired log retention settings.
20+
21+
See the [README](README.md) for additional information.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,9 @@ A container instance may be skipped for update when:
152152
The Bottlerocket ECS Updater uses newer [`apiclient update` commands](https://github.com/bottlerocket-os/bottlerocket#update-api) that were added in version [1.0.5](https://github.com/bottlerocket-os/bottlerocket/blob/develop/CHANGELOG.md#v105-2021-01-15).
153153
The SSM commands will fail if your Bottlerocket OS version is less than 1.0.5.
154154
Instances running Bottlerocket versions less than 1.0.5 need to be manually updated.
155+
* _Too many instances are in the cluster._
156+
The Bottlerocket ECS Updater currently supports clusters of up to 50 container instances.
157+
If the updater is configured to target a cluster with more than 50 instances, some instances may not be updated.
155158

156159
### Why do new container instances launch with older Bottlerocket versions?
157160

stacks/bottlerocket-ecs-updater.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Parameters:
1010
UpdaterImage:
1111
Description: 'Bottlerocket updater container image'
1212
Type: String
13+
Default: 'public.ecr.aws/bottlerocket/bottlerocket-ecs-updater:v0.1.0'
1314
LogGroupName:
1415
Description: 'Log group name for Bottlerocket updater logs'
1516
Type: String

0 commit comments

Comments
 (0)