ecr-deploy 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p551

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ecr-deploy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Keitaroh Kobayashi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# ecr-deploy
+
+Simple script to help with AWS ECR deploys.
+
+## Usage Overview
+
+0. Set up services and JSON task definition configuration in S3
+1. Install `ecr-deploy`: `gem install ecr-deploy`
+2. Set up configuration file (see `configuration.yml`)
+3. Run `ecr-deploy`:
+
+    ```
+    $ ecr-deploy path_to_configuration.yml $ENVIRONMENT_NAME $IMAGE_TAG
+    ```
+
+## About
+
+`ecr-deploy` makes a few assumptions about your ECR setup:
+
+You have multiple **environments** of tasks and services. The name of a service
+is formatted `ENVIRONMENT-NAME`. So, for example, the "web" service in a
+production environment would have the service name of `production-web`.
+
+Shared environment variables and ECS task definition files live in a S3 bucket.
+Shared environment variables are environment-specific, and are contained in a
+JSON file of the name `ENVIRONMENT-env.json`. Service and task configuration
+templates are contained in JSON files with the name `ENVIRONMENT-NAME.json`
+(where `NAME` is the service / task name specified in configuration.yml).
+
+A quick overview of the steps `ecr-deploy` will take when you run it with
+`$ ecr-deploy config.yml production 0abcdef`, when `config.yml` has a single
+"web" service in the "production" environemnt:
+
+1. Download the `production-env.json`
+2. Download `production-web.json`
+    1. Replace `[ENVIRONMENT]` with the environment loaded from `production-env.json`
+    2. Replace `[CURRENT_IMAGE_TAG]` with `0abcdef`
+3. Register the task definition using the contents of the previous step
+4. Update the `production-web` service to use the new task definition registered in the previous step
+5. Wait for the `production-web` to reach a stable state (will throw an error after 10 minutes)
+
+## Task Definition templates
+
+`ecr-deploy` uses the AWS SDK for Ruby which uses a slightly different format
+of the task definition JSON (under_scored instead of camelCased).
+
+```json
+{
+  "container_definitions": [
+    {
+      "volumes_from": [],
+      "port_mappings": [
+        {
+          "host_port": 80,
+          "container_port": 8000
+        }
+      ],
+      "command": [
+        "run_server"
+      ],
+      "environment": [
+        [ENVIRONMENT]
+      ],
+      "essential": true,
+      "entry_point": [],
+      "links": [],
+      "mount_points": [],
+      "memory": 500,
+      "name": "production-web",
+      "cpu": 256,
+      "image": "XXX.dkr.ecr.us-east-1.amazonaws.com/REPO_NAME:[CURRENT_IMAGE_TAG]"
+    }
+  ],
+  "volumes": [],
+  "family": "production-web"
+}
+```
+
+Notice `[ENVIRONMENT]` and `[CURRENT_IMAGE_TAG]` -- these tokens will be replaced
+on deploy.
+
+## `configuration.yml`
+
+```yaml
+---
+base_config:
+  # The S3 bucket that contains the task definition templates and environment
+  # files.
+  template_bucket: km-t01-config
+  # The prefix for template object file names. Used for disambiguation if you
+  # deploy multiple apps from the same bucket.
+  template_bucket_prefix: ecr-deploy-
+
+  # The name of the ECS cluster
+  cluster: default
+
+production:
+  # Services that will be updated
+  services:
+    - web
+
+  # Tasks that will be run as part of the deploy process (good for automatic
+  # migrations, etc)
+  run_tasks:
+    - migrator
+
+  # Tasks that will only be registered, not run. Good for on-demand workers.
+  register_tasks:
+    - worker
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ecr_deploy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/configuration.yml

@@ -0,0 +1,23 @@
+---
+base_config:
+  # The S3 bucket that contains the task definition templates and environment
+  # files.
+  template_bucket: km-t01-config
+  # The prefix for template object file names. Used for disambiguation if you
+  # deploy multiple apps from the same bucket.
+  template_bucket_prefix: ecr-deploy-
+
+  # The name of the ECS cluster
+  cluster: default
+
+production:
+  # Services that will be updated
+  services:
+    - web
+
+  # Tasks that will be run as part of the deploy process (good for automatic
+  # migrations, etc)
+  run_tasks: []
+
+  # Tasks that will only be registered, not run. Good for on-demand workers.
+  register_tasks: []

data/ecr-deploy.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ecr_deploy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecr-deploy"
+  spec.version       = EcrDeploy::VERSION
+  spec.authors       = ["Keitaroh Kobayashi"]
+  spec.email         = ["keita@kbys.me"]
+
+  spec.summary       = %q{A simple script to deploy services and tasks on AWS ECS}
+  spec.homepage      = "https://github.com/KotobaMedia/ecr-deploy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk", "~> 2.1"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/exe/ecr-deploy

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "ecr_deploy"
+require "ecr_deploy/optparse"
+require "ecr_deploy/cli"
+
+options = EcrDeploy::Optparse.parse(ARGV)
+EcrDeploy::CLI.run!(options)

data/lib/ecr_deploy.rb

@@ -0,0 +1,7 @@
+module EcrDeploy
+end
+
+require "aws-sdk"
+
+require_relative "./ecr_deploy/config"
+require_relative "./ecr_deploy/task"

data/lib/ecr_deploy/cli.rb

@@ -0,0 +1,11 @@
+class EcrDeploy::CLI
+  def self.run!(opts)
+    config = EcrDeploy::Config.new(opts.config_file)
+    task = EcrDeploy::Task.new(config, opts.environment_name)
+
+    task.deploy!(opts.image_tag)
+    task.wait_until_stable
+
+    puts "Deploy finished."
+  end
+end

data/lib/ecr_deploy/config.rb

@@ -0,0 +1,27 @@
+require "yaml"
+
+class EcrDeploy::Config
+  def initialize(path)
+    @config = YAML.load(IO.read(path))
+  end
+
+  def base_config
+    @config["base_config"]
+  end
+
+  def services(environment)
+    @config[environment]["services"] || []
+  end
+
+  def run_tasks(environment)
+    @config[environment]["run_tasks"] || []
+  end
+
+  def register_tasks(environment)
+    @config[environment]["register_tasks"] || []
+  end
+
+  def environments
+    @config.keys.reject { |e| e == "base_config" }
+  end
+end

data/lib/ecr_deploy/optparse.rb

@@ -0,0 +1,20 @@
+require "ostruct"
+
+class EcrDeploy::Optparse
+  def self.parse(args)
+    options = OpenStruct.new
+
+    options.config_file = args[0] || show_usage
+    options.environment_name = args[1] || show_usage
+    options.image_tag = args[2] || show_usage
+
+    options
+  end
+
+  private
+
+  def self.show_usage
+    puts "Usage: ecr-deploy path_to_configuration.yml ENVIRONMENT_NAME IMAGE_TAG"
+    exit 127
+  end
+end

data/lib/ecr_deploy/task.rb

@@ -0,0 +1,80 @@
+require 'json'
+
+class EcrDeploy::Task
+  def initialize(config, environment)
+    fail ArgumentError, "#{environment} does not exist in the configuration." \
+      if !config.environments.include?(environment)
+
+    @ecs = Aws::ECS::Client.new
+    s3 = Aws::S3::Resource.new
+
+    @cluster_name = config.base_config["cluster"]
+
+    @service_names = config.services(environment)
+    @run_task_names = config.run_tasks(environment)
+    @register_task_names = config.register_tasks(environment)
+
+    @bucket = s3.bucket(config.base_config["template_bucket"])
+    @bucket_prefix = config.base_config["template_bucket_prefix"] || ""
+
+    @environment = environment
+    @env_vars = @bucket.
+      object(build_path("#{environment}-env.json")).get.body.string
+  end
+
+  def deploy!(image_tag_name)
+    task_def_names = (@service_names + @run_task_names + @register_task_names).uniq
+    task_def_arns = task_def_names.map { |name| register_task_definition(name, image_tag_name) }
+    task_def = Hash[task_def_names.zip(task_def_arns)]
+
+    @service_names.each do |name|
+      service_name = "#{@environment}-#{name}"
+      $stderr.puts "==> Updating service \"#{service_name}\""
+      @ecs.update_service(
+        cluster: @cluster_name,
+        service: service_name,
+        task_definition: task_def[name])
+    end
+
+    @run_task_names.each do |name|
+      $stderr.puts "==> Running task \"#{name}\" in \"#{@environment}\""
+      @ecs.run_task(
+        cluster: @cluster_name,
+        task_definition: task_def[name],
+        count: 1)
+    end
+  end
+
+  def wait_until_stable(wait_time = 600)
+    services = @service_names.map { |name| "#{@environment}-#{name}" }
+    $stderr.puts "==> Waiting for #{services.join ", "} to stabilize..."
+    started_at = Time.now
+    @ecs.wait_until(:services_stable, cluster: @cluster, services: services) do |w|
+      w.max_attempts = nil
+
+      w.before_wait do |attempts, response|
+        throw :failure if Time.now - started_at > wait_time
+      end
+    end
+  rescue Aws::Waiters::Errors::WaiterFailed => e
+    $stderr.puts "!!> An error occurred while waiting for services to stabilize. #{e}"
+  end
+
+  def register_task_definition(name, image_tag_name)
+    template = @bucket.object(build_path("#{@environment}-#{name}.json")).
+      get.body.string
+    template.gsub!("[CURRENT_IMAGE_TAG]", image_tag_name)
+    template.gsub!("[ENVIRONMENT]", @env_vars)
+
+    template_obj = JSON.parse(template, symbolize_names: true)
+    task = @ecs.register_task_definition(template_obj)
+
+    task.task_definition.task_definition_arn
+  end
+
+  private
+
+  def build_path(path)
+    @bucket_prefix + path
+  end
+end

data/lib/ecr_deploy/version.rb

@@ -0,0 +1,3 @@
+module EcrDeploy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: ecr-deploy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Keitaroh Kobayashi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- keita@kbys.me
+executables:
+- ecr-deploy
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- configuration.yml
+- ecr-deploy.gemspec
+- exe/ecr-deploy
+- lib/ecr_deploy.rb
+- lib/ecr_deploy/cli.rb
+- lib/ecr_deploy/config.rb
+- lib/ecr_deploy/optparse.rb
+- lib/ecr_deploy/task.rb
+- lib/ecr_deploy/version.rb
+homepage: https://github.com/KotobaMedia/ecr-deploy
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: A simple script to deploy services and tasks on AWS ECS
+test_files: []