ufo 2.1.0 → 2.2.0

data/lib/ufo/docker.rb

@@ -1,12 +1,11 @@
 module Ufo
   class Docker < Command
-    autoload :Help, 'ufo/docker/help'
     autoload :Builder, 'ufo/docker/builder'
     autoload :Dockerfile, 'ufo/docker/dockerfile'
     autoload :Cleaner, 'ufo/docker/cleaner'
 
     desc "build", "builds docker image"
-    long_desc Help.build
+    long_desc Help.text("docker:build")
     option :push, type: :boolean, default: false
     def build
       builder = Docker::Builder.new(options)
@@ -15,7 +14,7 @@ module Ufo
     end
 
     desc "base", "builds docker image from Dockerfile.base and update current Dockerfile"
-    long_desc Help.base
+    long_desc Help.text("docker:base")
     option :push, type: :boolean, default: true
     def base
       builder = Docker::Builder.new(options.dup.merge(
@@ -31,7 +30,7 @@ module Ufo
 
     desc "name", "displays the full docker image with tag that will be generated"
     option :generate, type: :boolean, default: false, desc: "Generate a name without storing it"
-    long_desc Help.name
+    long_desc Help.text("docker:name")
     def name
       full_image_name = Docker::Builder.new(options).full_image_name
       puts full_image_name
@@ -40,7 +39,7 @@ module Ufo
     desc "clean IMAGE_NAME", "Cleans up old images.  Keeps a specified amount."
     option :keep, type: :numeric, default: 3
     option :tag_prefix, default: "ufo"
-    long_desc Help.clean
+    long_desc Help.text("docker:clean")
     def clean(image_name)
       Docker::Cleaner.new(image_name, options).cleanup
     end

data/lib/ufo/docker/builder.rb

@@ -103,7 +103,6 @@ module Ufo
       FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
       full_image_name = generate_name
       IO.write(docker_name_path, full_image_name)
-      IO.write("#{@project_root}/ufo/version", full_image_name)
     end
 
     def generate_name
@@ -112,7 +111,7 @@ module Ufo
 
     def docker_name_path
       # output gets entirely wiped by tasks builder so dotn use that folder
-      "#{@project_root}/ufo/docker_image_name_#{@image_namespace}.txt"
+      "#{@project_root}/ufo/data/docker_image_name_#{@image_namespace}.txt"
     end
 
     def timestamp

data/lib/ufo/env.rb

@@ -10,7 +10,7 @@ class Ufo::Env
     if map
       ufo_env = map[ENV['AWS_PROFILE']] || map['default']
     end
-    ufo_env ||= 'prod' # defaults to prod
+    ufo_env ||= 'development' # defaults to development
     ufo_env = ENV['UFO_ENV'] if ENV['UFO_ENV'] # highest precedence
 
     Kernel.const_set(:UFO_ENV, ufo_env)

data/lib/ufo/help.rb

@@ -0,0 +1,9 @@
+module Ufo::Help
+  class << self
+    def text(namespaced_command)
+      path = namespaced_command.to_s.gsub(':','/')
+      path = File.expand_path("../help/#{path}.md", __FILE__)
+      IO.read(path) if File.exist?(path)
+    end
+  end
+end

data/lib/ufo/help/destroy.md

@@ -0,0 +1,5 @@
+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

data/lib/ufo/help/docker.md

@@ -0,0 +1,4 @@
+Examples:
+
+  ufo docker build
+  ufo docker tag

data/lib/ufo/help/docker/base.md

@@ -0,0 +1,9 @@
+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.

data/lib/ufo/help/docker/build.md

@@ -0,0 +1,6 @@
+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.

data/lib/ufo/help/docker/clean.md

@@ -0,0 +1,14 @@
+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 clean tongueroo/hi
+
+This will remove tongueroo/hi:ufo-2016-10-15T19-29-06-88071f5.

data/lib/ufo/help/docker/name.md

@@ -0,0 +1,5 @@
+Examples:
+
+  ufo docker name
+
+Docker image name that will be used: tongueroo/hi:ufo-2016-10-15T19-29-06-88071f5

data/lib/ufo/help/init.md

@@ -0,0 +1,11 @@
+Examples:
+
+  ufo init --app=hi --image=tongueroo/hi
+
+The app is that application name that you want to show up on the ECS dashboard.  It is strongly encourage to have the app name be a single word.
+
+The image is the base portion of image name that will be pushed to the docker registry, ie: DockerHub or AWS ECR.  The image should not include the tag since the tag is generated upon a `ufo ship`.  For example:
+
+  tongueroo/hi => tongueroo/hi:ufo-2018-02-08T21-04-02-3c86158
+
+The generated `tongueroo/hi:ufo-2018-02-08T21-04-02-3c86158` image name gets pushed to the docker registry.

data/lib/ufo/help/scale.md

@@ -0,0 +1,5 @@
+Examples:
+
+Scales the service.  Simple wrapper for `aws ecs update-service --service xxx ----desired-count xxx`
+
+  ufo scale hi-web 5

data/lib/ufo/help/ship.md

@@ -0,0 +1,17 @@
+Examples:
+
+To build the docker image, generate the task definition and ship it, run:
+
+  ufo ship hi-web
+
+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-1` service and use the `hi-web` task, run:
+
+  ufo ship hi-web-1 --task hi-web
+
+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-target-group-prompt` option.
+
+  ufo ship hi-web --target-group arn:aws:elasticloadbalancing:us-east-1:123456789:targetgroup/hi-web/jsdlfjsdkd
+
+  ufo ship hi-web --no-target-group-prompt

data/lib/ufo/help/ships.md

@@ -0,0 +1,18 @@
+Builds docker image, registers it and ships it to multiple services.  This deploys the same docker image to multiple ECS services.
+
+Examples:
+
+  ufo ships hi-web hi-clock hi-worker
+
+By convention the task definition and service names match for each of the services you ship. If you need to override to this convention then you can specify the task definition for each service with a special syntax.  In the special syntax the service and task definition is separated by a colon.  Example:
+
+  ufo ships hi-web-1:hi-web hi-clock-1 hi-worker-1
+
+Here ufo will deploy to the hi-web-1 ECS Service using the hi-web task definition, but use the convention for the rest of the service.
+
+For each service being deployed to, ufo will create the ECS service if the service does not yet exist on the cluster.  The deploy process will prompt you for the ELB `--target-group` if you are deploying to a 'web' service that does not yet exist.  Ufo determines that it is a web service by the name of the service. If the service has 'web' in the name then it is considered a web service. If it is not a web service then the `--target-group` option gets ignored.
+
+The prommpt can be bypassed by specifying a valid `--target-group` option or specifying the `---no-target-group-prompt` option.  Examples:
+
+  ufo ships hi-web hi-clock hi-worker --target-group arn:aws:elasticloadbalancing:us-east-1:123456789:targetgroup/hi-web/jsdlfjsdkd
+  ufo ships hi-web hi-clock hi-worker --no-target-group-prompt

data/lib/ufo/help/task.md

@@ -0,0 +1,10 @@
+Examples:
+
+To run a one time task with ECS:
+
+  ufo task hi-migrate
+
+You can also override the command used by the Docker container in the task definitions via command.
+
+  ufo task hi-web --command bin/migrate
+  ufo task hi-web --command bin/with_env bundle exec rake db:migrate:redo VERSION=xxx

data/lib/ufo/help/tasks.md

@@ -0,0 +1,7 @@
+Examples:
+
+  ufo tasks build
+
+Builds all the task defintiions.
+
+Note all the existing ufo/output generated task defintions are wiped out.

data/lib/ufo/help/tasks/build.md

@@ -0,0 +1,7 @@
+Examples:
+
+  ufo tasks build
+
+Builds all the task defintiions.
+
+Note all the existing ufo/output generated task defintions are wiped out.

data/lib/ufo/help/tasks/register.md

@@ -0,0 +1,5 @@
+Examples:
+
+  ufo tasks register
+
+All the task defintiions in ufo/output registered.

data/lib/ufo/init.rb

@@ -58,9 +58,8 @@ module Ufo
 
     def ufo_ignores
       ignores =<<-EOL
-/ufo/output
-/ufo/docker_image_name*.txt
-/ufo/version
+ufo/output
+ufo/data
 EOL
     end
 

data/lib/ufo/ship.rb

@@ -227,7 +227,7 @@ module Ufo
     # the ECS console.  `ufo scale` will allow you to updated the desired_count from the
     # CLI though.
     def create_service
-      puts "This service #{@service} does not yet exist in the #{@cluster} cluster.  This deploy will create it."
+      puts "This service #{@service.colorize(:green)} does not yet exist in the #{@cluster.colorize(:green)} cluster.  This deploy will create it."
       container = container_info(@task_definition)
       target_group = target_group_prompt(container)
 

data/lib/ufo/task.rb

@@ -16,7 +16,11 @@ module Ufo
         cluster: @cluster,
         task_definition: @task_definition
       }
-      task_options.merge!(overrides: overrides) if @options[:command]
+      if @options[:command]
+        task_options.merge!(overrides: overrides)
+        puts "Running task with container overrides."
+        puts "Command: #{@options[:command].join(' ')}"
+      end
       resp = ecs.run_task(task_options)
       puts "Task ARN: #{resp.tasks[0].task_arn}" unless @options[:mute]
     end

data/lib/ufo/tasks.rb

@@ -1,18 +1,17 @@
 module Ufo
   class Tasks < Command
-    autoload :Help, 'ufo/tasks/help'
     autoload :Builder, 'ufo/tasks/builder'
     autoload :Register, 'ufo/tasks/register'
 
     desc "build", "builds task definitions"
-    long_desc Help.build
+    long_desc Help.text("tasks:build")
     option :pretty, type: :boolean, default: true, desc: "Pretty format the json for the task definitions"
     def build
       Tasks::Builder.new(options).build
     end
 
     desc "register", "register all built task definitions in ufo/output"
-    long_desc Help.register
+    long_desc Help.text("tasks:register")
     def register
       Tasks::Register.register(:all, options)
     end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/ufo.gemspec

@@ -22,7 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "hashie"
   spec.add_dependency "colorize"
   spec.add_dependency "deep_merge"
-  spec.add_dependency "aws-sdk"
+  spec.add_dependency "aws-sdk-ecs"
+  spec.add_dependency "aws-sdk-ec2"
+  spec.add_dependency "aws-sdk-elasticloadbalancingv2"
+  spec.add_dependency "aws-sdk-cloudwatchlogs"
   spec.add_dependency "plissken"
 
   spec.add_development_dependency "bundler", "~> 1.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2018-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -67,7 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-ecs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-elasticloadbalancingv2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudwatchlogs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -276,12 +318,11 @@ files:
 - lib/starter_project/ufo/task_definitions.rb
 - lib/starter_project/ufo/templates/main.json.erb
 - lib/starter_project/ufo/variables/base.rb
-- lib/starter_project/ufo/variables/prod.rb
-- lib/starter_project/ufo/variables/stag.rb
+- lib/starter_project/ufo/variables/development.rb
+- lib/starter_project/ufo/variables/production.rb
 - lib/ufo.rb
 - lib/ufo/aws_services.rb
 - lib/ufo/cli.rb
-- lib/ufo/cli/help.rb
 - lib/ufo/command.rb
 - lib/ufo/default/settings.yml
 - lib/ufo/defaults.rb
@@ -290,7 +331,6 @@ files:
 - lib/ufo/docker/builder.rb
 - lib/ufo/docker/cleaner.rb
 - lib/ufo/docker/dockerfile.rb
-- lib/ufo/docker/help.rb
 - lib/ufo/dsl.rb
 - lib/ufo/dsl/helper.rb
 - lib/ufo/dsl/outputter.rb
@@ -299,6 +339,21 @@ files:
 - lib/ufo/ecr/auth.rb
 - lib/ufo/ecr/cleaner.rb
 - lib/ufo/env.rb
+- lib/ufo/help.rb
+- lib/ufo/help/destroy.md
+- lib/ufo/help/docker.md
+- lib/ufo/help/docker/base.md
+- lib/ufo/help/docker/build.md
+- lib/ufo/help/docker/clean.md
+- lib/ufo/help/docker/name.md
+- lib/ufo/help/init.md
+- lib/ufo/help/scale.md
+- lib/ufo/help/ship.md
+- lib/ufo/help/ships.md
+- lib/ufo/help/task.md
+- lib/ufo/help/tasks.md
+- lib/ufo/help/tasks/build.md
+- lib/ufo/help/tasks/register.md
 - lib/ufo/init.rb
 - lib/ufo/log_group.rb
 - lib/ufo/scale.rb
@@ -307,7 +362,6 @@ files:
 - lib/ufo/task.rb
 - lib/ufo/tasks.rb
 - lib/ufo/tasks/builder.rb
-- lib/ufo/tasks/help.rb
 - lib/ufo/tasks/register.rb
 - lib/ufo/templates/default.json.erb
 - lib/ufo/util.rb
@@ -341,7 +395,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Build Docker Containers and Ship Them to AWS ECS

data/lib/ufo/cli/help.rb

@@ -1,124 +0,0 @@
-module Ufo
-  class CLI < Command
-    class Help
-      class << self
-        def init
-<<-EOL
-Examples:
-
-$ ufo init --app=hi --image=tongueroo/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 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 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-target-group-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-target-group-prompt
-EOL
-        end
-
-        def ships
-<<-EOL
-Builds docker image, registers it and ships it to multiple services.  This deploys the same docker image to multiple ECS services.
-
-Examples:
-
-$ ufo ships hi-web-prod hi-clock-prod hi-worker-prod
-
-By convention the task definition and service names match for each of the services you ship. If you need to override to this convention then you can specify the task definition for each service with a special syntax.  In the special syntax the service and task definition is separated by a colon.  Example:
-
-$ ufo ships hi-web-prod-1:hi-web-prod hi-clock-prod-1 hi-worker-prod-1
-
-Here ufo will deploy to the hi-web-prod-1 ECS Service using the hi-web-prod task definition, but use the convention for the rest of the service.
-
-For each service being deployed to, ufo will create the ECS service if the service does not yet exist on the cluster.  The deploy process will prompt you for the ELB `--target-group` if you are deploying to a 'web' service that does not yet exist.  Ufo determines that it is a web service by the name of the service. If the service has 'web' in the name then it is considered a web service. If it is not a web service then the `--target-group` option gets ignored.
-
-The prommpt can be bypassed by specifying a valid `--target-group` option or specifying the `---no-target-group-prompt` option.  Examples:
-
-$ ufo ships hi-web-prod hi-clock-prod hi-worker-prod --target-group arn:aws:elasticloadbalancing:us-east-1:123456789:targetgroup/hi-web-prod/jsdlfjsdkd
-
-$ ufo ships hi-web-prod hi-clock-prod hi-worker-prod --no-target-group-prompt
-EOL
-        end
-
-        def task
-<<-EOL
-Examples:
-
-To run a one time task with ECS:
-
-$ ufo task hi-migrate-prod
-
-You can also override the command used by the Docker container in the task definitions via command.
-
-ufo task hi-web-prod --command bin/migrate
-
-ufo task hi-web-prod --command bin/with_env bundle exec rake db:migrate:redo VERSION=xxx
-
-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