Helper script for deployment to Amazon ECS.
This gem is experimental.
Main purpose is combination with capistrano API.
Add this line to your application's Gemfile:
gem 'ecs_deploy', github: "reproio/ecs_deploy"And then execute:
$ bundle
Use by Capistrano.
# Capfile
require 'ecs_deploy/capistrano'
# deploy.rb
set :ecs_default_cluster, "ecs-cluster-name"
set :ecs_access_key_id, "dummy" # optional, if nil, use environment variable
set :ecs_secret_access_key, "dummy" # optional, if nil, use environment variable
set :ecs_region, %w(ap-northeast-1) # optional, if nil, use environment variable
set :ecs_service_role, "customEcsServiceRole" # default: ecsServiceRole
set :ecs_deploy_wait_timeout, 600 # default: 300
set :ecs_tasks, lambda {
[
{
name: "myapp-#{fetch(:rails_env)}",
container_definitions: [
{
name: "myapp",
image: "#{fetch(:docker_registry_host_with_port)}/myapp:#{fetch(:sha1)}",
cpu: 1024,
memory: 512,
port_mappings: [],
essential: true,
environment: [
{name: "RAILS_ENV", value: fetch(:rails_env)},
],
mount_points: [
{
source_volume: "sockets_path",
container_path: "/app/tmp/sockets",
read_only: false,
},
],
volumes_from: [],
log_configuration: {
log_driver: "fluentd",
options: {
"tag" => "docker.#{fetch(:rails_env)}.#{name}.{{.ID}}",
},
},
},
{
name: "nginx",
image: "#{fetch(:docker_registry_host_with_port)}/my-nginx",
cpu: 256,
memory: 256,
links: [],
port_mappings: [
{container_port: 443, host_port: 443, protocol: "tcp"},
],
essential: true,
environment: {},
mount_points: [],
volumes_from: [
{source_container: "myapp-#{fetch(:rails_env)}", read_only: false},
],
log_configuration: {
log_driver: "fluentd",
options: {
"tag" => "docker.#{fetch(:rails_env)}.#{name}.{{.ID}}",
},
},
}
],
volumes: [{name: "sockets_path", host: {}}],
executions: [ # execution task on deploy timing
{
container_overrides: [{name: "myapp", command: ["db_migrate"]}],
wait_stop: 'myapp'
},
]
},
]
}
set :ecs_services, lambda {
[
{
name: "myapp-#{fetch(:rails_env)}",
load_balancers: {
load_balancer_name: "app",
container_name: "nginx",
container_port: 443,
target_group_arn: fetch(:target_group_arn),
},
desired_count: 1,
deployment_configuration: {maximum_percent: 200, minimum_healthy_percent: 50},
},
]
}cap <stage> ecs:register_task_definition # register ecs_tasks as TaskDefinition
cap <stage> ecs:deploy # create or update Service by ecs_services info
cap <stage> ecs:rollback # deregister current task definition and update Service by previous revision of current task definition| sequence | taskdef | service | desc |
|---|---|---|---|
| 1 | myapp:12 | myapp-service | |
| 2 | myapp:13 | myapp-service | |
| 3 | myapp:14 | myapp-service | current |
After rollback
| sequence | taskdef | service | desc |
|---|---|---|---|
| 1 | myapp:12 | myapp-service | |
| 2 | myapp:13 | myapp-service | |
| 3 | myapp:14 | myapp-service | deregister |
| 4 | myapp:13 | myapp-service | current |
And rollback again
| sequence | taskdef | service | desc |
|---|---|---|---|
| 1 | myapp:12 | myapp-service | |
| 2 | myapp:13 | myapp-service | previous |
| 3 | myapp:14 | myapp-service | deregister |
| 4 | myapp:13 | myapp-service | deregister |
| 5 | myapp:12 | myapp-service | current |
And deploy new version
| sequence | taskdef | service | desc |
|---|---|---|---|
| 1 | myapp:12 | myapp-service | |
| 2 | myapp:13 | myapp-service | |
| 3 | myapp:14 | myapp-service | deregister |
| 4 | myapp:13 | myapp-service | deregister |
| 5 | myapp:12 | myapp-service | |
| 6 | myapp:15 | myapp-service | current |
And rollback
| sequence | taskdef | service | desc |
|---|---|---|---|
| 1 | myapp:12 | myapp-service | |
| 2 | myapp:13 | myapp-service | |
| 3 | myapp:14 | myapp-service | deregister |
| 4 | myapp:13 | myapp-service | deregister |
| 5 | myapp:12 | myapp-service | |
| 6 | myapp:15 | myapp-service | deregister |
| 7 | myapp:12 | myapp-service | current |
Write config file (YAML format).
# ポーリング時にupscale_triggersに指定した状態のalarmがあればstep分serviceとinstanceを増やす (max_task_countまで)
# ポーリング時にdownscale_triggersに指定した状態のalarmがあればstep分serviceとinstanceを減らす (min_task_countまで)
# max_task_countは段階的にリミットを設けられるようにする
# 一回リミットに到達するとcooldown_for_reach_maxを越えても状態が継続したら再開するようにする
polling_interval: 60
auto_scaling_groups:
- name: ecs-cluster-nodes
region: ap-northeast-1
buffer: 1 # タスク数に対する余剰のインスタンス数
services:
- name: repro-api-production
cluster: ecs-cluster
region: ap-northeast-1
auto_scaling_group_name: ecs-cluster-nodes
step: 1
idle_time: 240
max_task_count: [10, 25]
scheduled_min_task_count:
- {from: "1:45", to: "4:30", count: 8}
cooldown_time_for_reach_max: 600
min_task_count: 0
upscale_triggers:
- alarm_name: "ECS [repro-api-production] CPUUtilization"
state: ALARM
- alarm_name: "ELB repro-api-a HTTPCode_Backend_5XX"
state: ALARM
step: 2
downscale_triggers:
- alarm_name: "ECS [repro-api-production] CPUUtilization (low)"
state: OKecs_auto_scaler <config yaml>I recommends deploy ecs_auto_scaler on ECS too.
After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/joker1007/ecs_deploy.