ufo 0.0.6

data/lib/starter_project/.env.prod

@@ -0,0 +1,3 @@
+# fine to have comment in this file
+ADMIN_PASSWORD=secret
+DATABASE_URL=mysql2://user:pass@domain.com:3306/dbname # comment can be at the end too

data/lib/starter_project/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:2.3.3
+MAINTAINER Tung Nguyen <tongueroo@gmail.com>
+
+# This is just a sample Dockerfile. This is meant to be overriden.
+
+# Install bundle of gems first in a layer
+# so if the Gemfile doesnt chagne it wont have to install gems again
+WORKDIR /tmp
+COPY Gemfile* /tmp/
+RUN bundle install && rm -rf /root/.bundle/cache
+
+# Add the Rails app
+ENV HOME /root
+WORKDIR /app
+COPY . /app
+RUN bundle install
+RUN mkdir -p tmp/cache tmp/pids
+
+EXPOSE 5001
+CMD ["bin/web"]

data/lib/starter_project/bin/deploy

@@ -0,0 +1,12 @@
+#!/bin/bash -xe
+
+# Generated started bin/deploy script.  Meant to be example only and should probably
+# be overridden.
+
+# Only build docker image on with the first command.
+ufo ship <%= @app %>-clock --cluster <%= @cluster %> --no-wait
+# Skipping the docker build phase for the rest of the ship commands
+ufo ship <%= @app %>-worker --cluster <%= @cluster %> --no-wait --no-docker
+# The final service will wait for the deploy to finish.  Please specify an
+# Application Load Balancer if creating the service for the first time.
+ufo ship <%= @app %>-web --cluster <%= @cluster %> --no-docker --target-group ''

data/lib/starter_project/ufo/settings.yml

@@ -0,0 +1,7 @@
+image: <%= @image %>
+service_cluster:
+  default: <%= @cluster %> # default cluster
+  # can override the default cluster for each service.  CLI overrides all of these settings.
+  <%= @app %>-web-prod:
+  <%= @app %>-clock-prod:
+  <%= @app %>-worker-prod:

data/lib/starter_project/ufo/task_definitions.rb

@@ -0,0 +1,44 @@
+# There will be some special variables that are automatically available in this file.
+#
+# Some of variables are from the Dockerfile and some are from other places.
+#
+# * helper.full_image_name - Docker image name with the tag when docker image is built by ufo. This is defined in ufo/settings.yml.  The helper.full_image_name includes the git sha tongueroo/hi:ufo-[sha].
+# * helper.dockerfile_port - Expose port in the Dockerfile.  Only supports one exposed port, the first one that is encountered.
+#
+# env_vars - is a helper method that generates the proper environment Array of Hashes
+
+# common variables
+common = {
+  image: helper.full_image_name, # includes the git sha tongueroo/hi:ufo-[sha].
+  cpu: 128,
+  memory_reservation: 256,
+  environment: env_file(".env.prod")
+}
+
+task_definition "<%= @app %>-web" do
+  source "main" # will use ufo/templates/main.json.erb
+  variables(common.dup.deep_merge(
+    family: task_definition_name,
+    name: "web",
+    container_port: helper.dockerfile_port,
+    command: ["bin/web"]
+  ))
+end
+
+task_definition "<%= @app %>-worker" do
+  source "main" # will use ufo/templates/main.json.erb
+  variables(common.dup.deep_merge(
+    family: task_definition_name,
+    name: "worker",
+    command: ["bin/worker"]
+  ))
+end
+
+task_definition "<%= @app %>-clock" do
+  source "main" # will use ufo/templates/main.json.erb
+  variables(common.dup.deep_merge(
+    family: task_definition_name,
+    name: "clock",
+    command: ["bin/clock"]
+  ))
+end

data/lib/starter_project/ufo/templates/main.json.erb

@@ -0,0 +1,39 @@
+{
+    "family": "<%= @family %>",
+    "containerDefinitions": [
+        {
+            "name": "<%= @name %>",
+            "image": "<%= @image %>",
+            "cpu": <%= @cpu %>,
+            <% if @memory %>
+            "memory": <%= @memory %>,
+            <% end %>
+            <% if @memory_reservation %>
+            "memoryReservation": <%= @memory_reservation %>,
+            <% end %>
+            <% if @container_port %>
+            "portMappings": [
+                {
+                    "containerPort": "<%= @container_port %>",
+                    "protocol": "tcp"
+                }
+            ],
+            <% end %>
+            "command": <%= @command.to_json %>,
+            <% if @environment %>
+            "environment": <%= @environment.to_json %>,
+            <% end %>
+            <% if @awslogs_group %>
+            "logConfiguration": {
+                "logDriver": "awslogs",
+                "options": {
+                    "awslogs-group": "<%= @awslogs_group %>",
+                    "awslogs-region": "<%= @awslogs_region || 'us-east-1' %>",
+                    "awslogs-stream-prefix": "<%= @awslogs_stream_prefix %>"
+                }
+            },
+            <% end %>
+            "essential": true
+        }
+    ]
+}

data/lib/ufo.rb

@@ -0,0 +1,26 @@
+$:.unshift(File.expand_path("../", __FILE__))
+require "ufo/version"
+require "pp"
+require 'deep_merge'
+require "colorize"
+
+module Ufo
+  autoload :Settings, 'ufo/settings'
+  autoload :PrettyTime, 'ufo/pretty_time'
+  autoload :Execute, 'ufo/execute'
+  autoload :Init, 'ufo/init'
+  autoload :EcrAuth, 'ufo/ecr_auth'
+  autoload :CLI, 'ufo/cli'
+  autoload :DockerBuilder, 'ufo/docker_builder'
+  autoload :DockerfileUpdater, 'ufo/dockerfile_updater'
+  autoload :DockerCleaner, 'ufo/docker_cleaner'
+  autoload :TasksBuilder, 'ufo/tasks_builder'
+  autoload :TasksRegister, 'ufo/tasks_register'
+  autoload :Ship, 'ufo/ship'
+  autoload :EcrCleaner, 'ufo/ecr_cleaner'
+  autoload :Destroy, 'ufo/destroy'
+  autoload :Scale, 'ufo/scale'
+  # modules
+  autoload :Defaults, 'ufo/defaults'
+  autoload :AwsServices, 'ufo/aws_services'
+end

data/lib/ufo/aws_services.rb

@@ -0,0 +1,21 @@
+require 'aws-sdk'
+
+module Ufo
+  module AwsServices
+    def ecs
+      @ecs ||= Aws::ECS::Client.new(region: region)
+    end
+
+    def elb
+      @elb ||= Aws::ElasticLoadBalancingV2::Client.new(region: region)
+    end
+
+    def ecr
+      @ecr ||= Aws::ECR::Client.new(region: region)
+    end
+
+    def region
+      ENV['REGION'] || 'us-east-1'
+    end
+  end
+end

data/lib/ufo/cli.rb

@@ -0,0 +1,136 @@
+require 'thor'
+require 'ufo/cli/help'
+
+module Ufo
+  class Docker < Thor
+    desc "build", "builds docker image"
+    long_desc CLI::Help.docker_build
+    option :push, type: :boolean, default: false
+    def build
+      builder = DockerBuilder.new(options)
+      builder.build
+      builder.push if options[:push]
+    end
+
+    desc "base", "builds docker image from Dockerfile.base"
+    long_desc CLI::Help.docker_base
+    option :push, type: :boolean, default: true
+    def base
+      builder = DockerBuilder.new(options.dup.merge(
+        image_namespace: "base",
+        dockerfile: "Dockerfile.base"
+      ))
+      builder.build
+      builder.push if options[:push]
+      builder.update_dockerfile
+      DockerCleaner.new(builder.image_name, options.merge(tag_prefix: "base")).cleanup
+      EcrCleaner.new(builder.image_name, options.merge(tag_prefix: "base")).cleanup
+    end
+
+    desc "full_image_name", "displays the full docker image with tag that will be generated"
+    long_desc CLI::Help.docker_full_image_name
+    def full_image_name
+      full_image_name = DockerBuilder.new(options).full_image_name
+      puts "Docker image name that will be used: #{full_image_name}"
+    end
+
+    desc "cleanup IMAGE_NAME", "Cleans up old images.  Keeps a specified amount."
+    option :keep, type: :numeric, default: 3
+    option :tag_prefix, default: "ufo"
+    long_desc CLI::Help.docker_cleanup
+    def cleanup(image_name)
+      DockerCleaner.new(image_name, options).cleanup
+    end
+  end
+
+  class Tasks < Thor
+    desc "build", "builds task definitions"
+    long_desc CLI::Help.tasks_build
+    option :pretty, type: :boolean, default: true, desc: "Pretty format the json for the task definitions"
+    def build
+      TasksBuilder.new(options).build
+    end
+
+    desc "register", "register all built task definitions in ufo/output"
+    long_desc CLI::Help.tasks_register
+    def register
+      TasksRegister.register_all(options)
+    end
+  end
+
+  class CLI < Thor
+    class_option :verbose, type: :boolean
+    class_option :mute, type: :boolean
+    class_option :noop, type: :boolean
+    class_option :project_root, type: :string, default: '.'
+    class_option :cluster, desc: "Cluster.  Overrides ufo/settings.yml."
+
+    desc "docker ACTION", "docker related tasks"
+    long_desc Help.docker
+    subcommand "docker", Docker
+
+    desc "tasks ACTION", "task definition related tasks"
+    long_desc Help.tasks
+    subcommand "tasks", Tasks
+
+    desc "init", "setup initial ufo files"
+    option :cluster, type: :string, required: true, desc: "ECS cluster name. Example: default"
+    option :image, type: :string, required: true, desc: "Docker image name without the tag. Example: tongueroo/hi"
+    option :app, type: :string, required: true, desc: "App name. Preferably one word. Used in the generated ufo/task_definitions.rb."
+    long_desc Help.init
+    def init
+      Init.new(options).setup
+    end
+
+    desc "ship [SERVICE]", "ships container to the ECS service"
+    option :task, desc: "ECS task name, to override the task name convention."
+    option :target_group, desc: "ELB Target Group ARN."
+    option :elb, desc: "ELB Name associated with the target_group.  Assumes first "
+    option :elb_prompt, type: :boolean, desc: "Enable ELB prompt", default: true
+    option :docker, type: :boolean, desc: "Enable docker build and push", default: true
+    option :wait, type: :boolean, desc: "Wait for deployment to complete", default: true
+    option :pretty, type: :boolean, default: true, desc: "Pretty format the json for the task definitions"
+    option :stop_old_tasks, type: :boolean, default: false, desc: "Stop old tasks after waiting for deploying to complete"
+    option :ecr_keep, type: :numeric, desc: "ECR specific cleanup of old images.  Specifies how many images to keep.  Only runs if the images are ECR images. Defaults to keeping all the images."
+    long_desc Help.ship
+    def ship(service)
+      builder = DockerBuilder.new(options) # outside if because it need docker.full_image_name
+      if options[:docker]
+        builder.build
+        builder.push
+      end
+
+      # task definition and deploy logic are coupled in the Ship class.
+      # Example: We need to know if the task defintion is a web service to see if we need to
+      # add the elb target group.  The web service information is in the TasksBuilder
+      # and the elb target group gets set in the Ship class.
+      # So we always call these together.
+      TasksBuilder.new(options).build
+      TasksRegister.register(service, options)
+      task_definition = options[:task] || service # convention
+      ship = Ship.new(service, task_definition, options)
+
+      return if ENV['TEST'] # to allow me to quickly test most of the ship CLI portion only
+      ship.deploy
+      if options[:docker]
+        DockerCleaner.new(builder.image_name, options).cleanup
+        EcrCleaner.new(builder.image_name, options).cleanup
+      end
+      puts "Docker image shipped: #{builder.full_image_name.green}"
+    end
+
+    desc "destroy [SERVICE]", "destroys the ECS service"
+    long_desc Help.destroy
+    option :force, type: :boolean, desc: "By pass are you sure prompt."
+    def destroy(service)
+      task_definition = options[:task] || service # convention
+      Destroy.new(service, options).bye
+    end
+
+    desc "scale [SERVICE] [COUNT]", "scale the ECS service"
+    long_desc Help.scale
+    def scale(service, count)
+      Scale.new(service, count, options).update
+    end
+  end
+end

data/lib/ufo/cli/help.rb

@@ -0,0 +1,164 @@
+module Ufo
+  class CLI < Thor
+    class Help
+      class << self
+        def init
+<<-EOL
+Examples:
+
+$ ufo init --cluster prod --image tongueroo/hi --app hi
+
+The image should not include the tag since the tag is generated upon a `ufo ship`.
+EOL
+        end
+
+        def docker
+<<-EOL
+Examples:
+
+$ ufo docker build
+
+$ ufo docker tag
+EOL
+        end
+
+        def docker_base
+<<-EOL
+
+The docker cache task builds a docker image using the Dockerfile.base file and
+updates the FROM Dockerfile image with the generated image from Dockerfile.base.
+
+Examples:
+
+$ ufo docker base
+
+$ ufo docker base --no-push # do not push the image to the registry
+
+Docker image tongueroo/hi:base-2016-10-21T15-50-57-88071f5 built.
+EOL
+        end
+
+        def docker_build
+<<-EOL
+Examples:
+
+$ ufo docker build
+
+$ ufo docker build --push # also pushes the image to the docker registry
+
+Docker image tongueroo/hi:ufo-2016-10-21T15-50-57-88071f5 built.
+EOL
+        end
+
+        def docker_full_image_name
+<<-EOL
+Examples:
+
+$ ufo docker full_image_name
+
+Docker image name that will be used: tongueroo/hi:ufo-2016-10-15T19-29-06-88071f5
+EOL
+        end
+
+        def docker_cleanup
+<<-EOL
+Examples:
+
+Say you currently have these images:
+
+* tongueroo/hi:ufo-2016-10-15T19-29-06-88071f5
+
+* tongueroo/hi:ufo-2016-10-16T19-29-06-88071f5
+
+* tongueroo/hi:ufo-2016-10-17T19-29-06-88071f5
+
+* tongueroo/hi:ufo-2016-10-18T19-29-06-88071f5
+
+To clean them up and keep the 3 more recent:
+
+$ ufo docker cleanup tongueroo/hi
+
+This will remove tongueroo/hi:ufo-2016-10-15T19-29-06-88071f5.
+EOL
+        end
+
+        def tasks
+<<-EOL
+Examples:
+
+$ ufo tasks build
+
+Builds all the task defintiions.
+
+Note all the existing ufo/output generated task defintions are wiped out.
+EOL
+        end
+
+        def tasks_build
+<<-EOL
+Examples:
+
+$ ufo tasks build
+
+Builds all the task defintiions.
+
+Note all the existing ufo/output generated task defintions are wiped out.
+EOL
+        end
+
+        def tasks_register
+<<-EOL
+Examples:
+
+$ ufo tasks register
+All the task defintiions in ufo/output registered.
+EOL
+        end
+
+        def ship
+<<-EOL
+Examples:
+
+To build the docker image, generate the task definition and ship it, run:
+
+$ ufo ship hi-web-prod
+
+By convention the task and service names match. If you need override to this convention then you can specific the task.  For example if you want to ship to the `hi-web-prod-1` service and use the `hi-web-prod` task, run:
+
+$ ufo ship hi-web-prod-1 --task hi-web-prod
+
+The deploy will also created the ECS service if the service does not yet exist on the cluster.  The deploy will prompt you for the ELB `--target-group` if you are shipping a web container that does not yet exist.  If it is not a web container the `--target-group` option gets ignored.
+
+The prommpt can be bypassed by specifying a valid `--target-group` option or specifying the `---no-elb-prompt` option.
+
+$ ufo ship hi-web-prod --target-group arn:aws:elasticloadbalancing:us-east-1:123456789:targetgroup/hi-web-prod/jsdlfjsdkd
+
+$ ufo ship hi-web-prod --no-elb-prompt
+EOL
+        end
+
+        def destroy
+<<-EOL
+Examples:
+
+Destroys the service.  It will automatcally set the desired task size to 0 and stop all task so the destory happens in one command.
+
+$ ufo destroy hi-web-prod
+
+EOL
+        end
+
+        def scale
+<<-EOL
+Examples:
+
+Scales the service.  Simple wrapper for `aws ecs update-service --service xxx ----desired-count xxx`
+
+$ ufo scale hi-web-prod 5
+
+EOL
+        end
+      end
+    end
+  end
+end