ufo 3.3.2 → 3.4.0

data/lib/template/.ufo/variables/base.rb.tt

@@ -0,0 +1,15 @@
+# Example ufo/variables/base.rb
+# More info on how variables work: http://ufoships.com/docs/variables/
+@image = helper.full_image_name # includes the git sha tongueroo/hi:ufo-[sha].
+@environment = helper.env_file(".env")
+<% if @options[:launch_type] == "fargate" -%>
+# Ensure that the cpu and memory values are a supported combination by Fargate.
+# More info: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html"
+<% end -%>
+@cpu = 256
+@memory = 512
+@memory_reservation = 256
+
+<% if @execution_role_arn_input -%>
+@execution_role_arn = "<%= @execution_role_arn_input %>"
+<% end -%>

data/lib/template/.ufo/variables/development.rb

@@ -1,6 +1,6 @@
 # Example ufo/variables/development.rb
 # More info on how variables work: http://ufoships.com/docs/variables/
-@cpu = 192
+@cpu = 256
 @environment = helper.env_vars(%Q[
   RAILS_ENV=development
   SECRET_KEY_BASE=secret

data/lib/ufo.rb

@@ -7,7 +7,6 @@ require 'render_me_pretty'
 
 module Ufo
   autoload :Core, 'ufo/core'
-  autoload :Default, 'ufo/default'
   autoload :AwsService, 'ufo/aws_service'
   autoload :Command, 'ufo/command'
   autoload :Setting, 'ufo/setting'
@@ -23,6 +22,8 @@ module Ufo
   autoload :Scale, 'ufo/scale'
   autoload :LogGroup, 'ufo/log_group'
   autoload :ECS, 'ufo/ecs'
+  autoload :Param, 'ufo/param'
+  autoload :TemplateScope, 'ufo/template_scope'
 
   autoload :Docker, 'ufo/docker'
   autoload :Ecr, 'ufo/ecr'
@@ -30,6 +31,7 @@ module Ufo
   autoload :Completion, "ufo/completion"
   autoload :Completer, "ufo/completer"
   autoload :Upgrade3, "ufo/upgrade3"
+  autoload :Upgrade33_to_34, "ufo/upgrade33_to_34"
 
   extend Core
 end

data/lib/ufo/cli.rb

@@ -77,9 +77,9 @@ module Ufo
     desc "task TASK_DEFINITION", "Run a one-time task."
     long_desc Help.text(:task)
     option :docker, type: :boolean, desc: "Enable docker build and push", default: true
-    option :command, type: :array, desc: "Override the command used for the container"
+    option :command, type: :array, aliases: 'c', desc: "Override the command used for the container"
     def task(task_definition)
-      Docker::Builder.build(options)
+      Docker::Builder.build(options) if @options[:docker]
       Tasks::Builder.ship(task_definition, options)
       Task.new(task_definition, options).run
     end
@@ -111,11 +111,15 @@ module Ufo
     end
 
     desc "upgrade3", "Upgrade from version 2 to 3."
-    long_desc Help.text("upgrade3")
     def upgrade3
       Upgrade3.new(options).run
     end
 
+    desc "upgrade3_3_to_3_4", "Upgrade from version 3.3 to 3.4"
+    def upgrade3_3_to_3_4
+      Upgrade33_to_34.new(options).run
+    end
+
     desc "version", "Prints version number of installed ufo."
     def version
       puts VERSION

data/lib/ufo/default/settings.yml

@@ -7,10 +7,6 @@ base:
   # clean_keep: 30
   # ecr_keep: 30
   # defaults when an new ECS service is created by ufo ship
-  new_service:
-    maximum_percent: 200
-    minimum_healthy_percent: 100
-    desired_count: 1
 
 development:
   # cluster: dev

data/lib/ufo/destroy.rb

@@ -1,6 +1,6 @@
 module Ufo
   class Destroy
-    include Default
+    include Util
     include AwsService
 
     def initialize(service, options={})

data/lib/ufo/docker/builder.rb

@@ -51,7 +51,7 @@ class Ufo::Docker
 
     # full_image - does not include the tag
     def image_name
-      setting.data["image"]
+      settings["image"]
     end
 
     # full_image - includes the tag
@@ -97,10 +97,6 @@ class Ufo::Docker
       @git_sha.strip!
     end
 
-    def setting
-      @setting ||= Ufo::Setting.new(Ufo.root)
-    end
-
     def update_dockerfile
       dockerfile = Dockerfile.new(full_image_name, @options)
       dockerfile.update

data/lib/ufo/docker/cleaner.rb

@@ -1,14 +1,13 @@
 module Ufo
   class Docker::Cleaner
     include Util
-    include Default
 
     def initialize(docker_image_name, options)
       # docker_image_name does not containg the tag
       # Example: 123456789.dkr.ecr.us-east-1.amazonaws.com/image
       @docker_image_name = docker_image_name
       @options = options
-      @keep = options[:keep] || setting.data["clean_keep"] || 3
+      @keep = options[:keep] || settings["clean_keep"] || 3
       @tag_prefix = options[:tag_prefix] || "ufo"
     end
 

data/lib/ufo/docker/pusher.rb

@@ -43,11 +43,7 @@ class Ufo::Docker
 
     # full_image - does not include the tag
     def image_name
-      setting.data["image"]
-    end
-
-    def setting
-      @setting ||= Ufo::Setting.new(Ufo.root)
+      settings["image"]
     end
   end
 end

data/lib/ufo/dsl.rb

@@ -89,7 +89,7 @@ module Ufo
     end
 
     def helper
-      Helper.new(@options)
+      Helper.new
     end
   end
 end

data/lib/ufo/dsl/helper.rb

@@ -8,9 +8,7 @@ module Ufo
   class DSL
     # provides some helperally context variables
     class Helper
-      def initialize(options={})
-        @options = options
-      end
+      include Ufo::Util
 
       ##############
       # helper variables
@@ -22,7 +20,8 @@ module Ufo
       end
 
       def full_image_name
-        Docker::Builder.new(@options).full_image_name
+        # Dont need to use @options here. Helps simplify the Helper initialization.
+        Docker::Builder.new({}).full_image_name
       end
 
       #############
@@ -64,10 +63,6 @@ module Ufo
         @current_region ||= `aws configure get region`.strip rescue 'us-east-1'
       end
 
-      def setting
-        @setting ||= Setting.new(Ufo.root)
-      end
-
       def parse_for_dockerfile_port(dockerfile_path)
         lines = IO.read(dockerfile_path).split("\n")
         expose_line = lines.find { |l| l =~ /^EXPOSE / }

data/lib/ufo/dsl/task_definition.rb

@@ -17,52 +17,14 @@ module Ufo
         @dsl.helper
       end
 
-      def build
-        load_variables
-        instance_eval(&@block)
-
-        hash = assign_instance_variables
-        RenderMePretty.result(source_path, hash)
-      end
-
-      def assign_instance_variables
-        # copy over the instance variables from TaskDefinition scope to RenderMePretty's scope
-        hash = {}
-        instance_variables.each do |var|
-          key = var.to_s.sub('@','') # rid of the leading @
-          hash[key.to_sym] = instance_variable_get(var)
-        end
-        hash
-      end
-
-      def load_variables
-        load_variables_file("base")
-        load_variables_file(Ufo.env)
+      def template_scope
+        @template_scope ||= Ufo::TemplateScope.new(helper)
       end
 
-      # Load the variables defined in ufo/variables/* to make available in the
-      # template blocks in ufo/templates/*.
-      #
-      # Example:
-      #
-      #   `ufo/variables/base.rb`:
-      #     @name = "docker-process-name"
-      #     @image = "docker-image-name"
-      #
-      #   `ufo/templates/main.json.erb`:
-      #   {
-      #     "containerDefinitions": [
-      #       {
-      #          "name": "<%= @name %>",
-      #          "image": "<%= @image %>",
-      #      ....
-      #   }
-      #
-      # NOTE: Only able to make instance variables avaialble with instance_eval
-      #   Wasnt able to make local variables available.
-      def load_variables_file(filename)
-        path = "#{Ufo.root}/.ufo/variables/#{filename}.rb"
-        instance_eval(IO.read(path)) if File.exist?(path)
+      def build
+        instance_eval(&@block)
+        vars = template_scope.assign_instance_variables
+        RenderMePretty.result(source_path, vars)
       end
 
       # at this point instance_eval has been called and source has possibly been called
@@ -75,7 +37,7 @@ module Ufo
           if instance_variable_defined?("@#{var}")
             puts "WARNING: The instance variable @#{var} is already used internally with ufo.  Please name you variable another name!"
           end
-          instance_variable_set("@#{var}", value)
+          template_scope.instance_variable_set("@#{var}", value)
         end
       end
 

data/lib/ufo/ecr/cleaner.rb

@@ -5,15 +5,15 @@ require "json"
 #   ufo ship app-web --cluster prod --noop
 module Ufo
   class Ecr::Cleaner
+    include Util
     include AwsService
-    include Default
 
     def initialize(docker_image_name, options={})
       # docker_image_name does not containg the tag
       # Example: 123456789.dkr.ecr.us-east-1.amazonaws.com/image
       @docker_image_name = docker_image_name
       @options = options
-      @keep = options[:ecr_keep] || setting.data["ecr_keep"]
+      @keep = options[:ecr_keep] || settings["ecr_keep"]
       @tag_prefix = options[:tag_prefix] || "ufo"
     end
 

data/lib/ufo/help/deploy.md

@@ -7,7 +7,15 @@ The above command does the following:
 1. register the `.ufo/output/hi-web.json` task definition to ECS untouched.
 2. deploys it to ECS by updating the service
 
-The `ufo deploy` command does less than the `ufo ship` command.  Typically, people use `ufo ship` over the `ufo deploy` command do everything in one step:
+### ufo tasks build
+
+To regenerate a `.ufo/output/hi-web.json` definition:
+
+    ufo tasks build
+
+### ufo ship
+
+The `ufo deploy` command does less than the `ufo ship` command.  Normally, it is recommended to use `ufo ship` over the `ufo deploy` command to do everything in one step:
 
 1. build the Docker image
 2. register the ECS task definition

data/lib/ufo/help/init.md

@@ -19,6 +19,12 @@ For this example we will use [tongueroo/hi](https://github.com/tongueroo/hi) whi
           append  .gitignore
     Starter ufo files created.
 
+## More Short Examples
+
+    ufo init --image httpd --app demo
+    ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage --app demo
+    ufo init --image tongueroo/hi --app hi --launch-type fargate --execution-role-arn arn:aws:iam::536766270177:role/ecsTaskExecutionRole
+
 ## Options: app and image
 
 The `app` is that application name that you want to show up on the ECS dashboard.  It is encouraged to have the app name be a single word.
@@ -46,6 +52,18 @@ The standard directory structure of the `.ufo` folder that was created looks lik
 
 For a explanation of the folders and files refer to [Structure]({% link _docs/structure.md %}).
 
+## Fargate Support
+
+For ECS Fargate, the ECS task definition structure is a bit different.  To initialize a project to support Fargate use the `--launch-type fargate` option.  You'll be prompted for a execution role arn.  This value gets added to the generated `.ufo/variables/base.rb` and used in the `.ufo/templates/main.json.erb`.
+
+    ufo init --image tongueroo/hi --app hi --force --launch-type fargate
+
+You can also generate the init ufo files and bypass the prompt by providing the `----execution-role-arn` option upfront.
+
+    ufo init --image tongueroo/hi --app hi --force --launch-type fargate --execution-role-arn arn:aws:iam::536766270177:role/ecsTaskExecutionRole
+
+Important: You will need to adjust adjust the generated `.ufo/params.yml` and set the subnet and security_group values which are required for Fargate.
+
 ## Custom Templates
 
 If you would like the `ufo init` command to use your own custom templates, you can achieve this with the `--template` and `--template-mode` options.  Example:

data/lib/ufo/help/task.md

@@ -1,10 +1,10 @@
 ## Examples
 
-To run a one time task with ECS:
+You can use the `--command` or `-c` option to override the Docker container command.
 
-  ufo task hi-migrate
+    ufo task hi-migrate # default command
+    ufo task hi-web --command bin/migrate
+    ufo task hi-web --command bin/with_env bundle exec rake db:migrate:redo VERSION=xxx
+    ufo task hi-web -c uptime
+    ufo task hi-web -c pwd
 
-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/init.rb

@@ -9,6 +9,8 @@ module Ufo
         [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
         [:image, required: true, desc: "Docker image name without the tag. Example: tongueroo/hi. Configures ufo/settings.yml"],
         [:app, required: true, desc: "App name. Preferably one word. Used in the generated ufo/task_definitions.rb."],
+        [:launch_type, default: "ec2", desc: "ec2 or fargate."],
+        [:execution_role_arn, desc: "execution role arn used by tasks, required for fargate."],
         [:template, desc: "Custom template to use."],
         [:template_mode, desc: "Template mode: replace or additive."],
       ]
@@ -50,11 +52,16 @@ module Ufo
       # map variables
       @app = options[:app]
       @image = options[:image]
+      @execution_role_arn_input = get_execution_role_arn_input
       # copy the files
       puts "Setting up ufo project..."
+      directory ".", exclude_pattern: /(\.git|templates)/
 
-      # directory ".ufo", ".ufo"
-      directory ".", exclude_pattern: /\.git/
+      if @options[:launch_type] == "fargate"
+        copy_file ".ufo/templates/fargate.json.erb", ".ufo/templates/main.json.erb"
+      else
+        copy_file ".ufo/templates/main.json.erb"
+      end
     end
 
     def upsert_gitignore

data/lib/ufo/param.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+require 'memoist'
+
+module Ufo
+  class Param
+    extend Memoist
+
+    def initialize
+      @params_path = "#{Ufo.root}/.ufo/params.yml"
+    end
+
+    def helper
+      dsl = DSL.new("#{Ufo.root}/.ufo/task_definitions.rb", quiet: true, mute: true)
+      dsl.helper
+    end
+
+    def data
+      vars = Ufo::TemplateScope.new(helper).assign_instance_variables
+      result = RenderMePretty.result(@params_path, vars)
+      YAML.load(result)
+    end
+    memoize :data
+  end
+end

data/lib/ufo/scale.rb

@@ -1,6 +1,6 @@
 module Ufo
   class Scale
-    include Default
+    include Util
     include AwsService
 
     def initialize(service, count, options={})

data/lib/ufo/sequence.rb

@@ -11,6 +11,20 @@ module Ufo
     end
 
   private
+    def get_execution_role_arn_input
+      return @execution_role_arn if @execution_role_arn
+
+      if @options[:execution_role_arn]
+        @execution_role_arn = @options[:execution_role_arn]
+        return @execution_role_arn
+      end
+
+      return unless @options[:launch_type] == "fargate"
+      # execution role arn required for fargate
+      print "Please provide a execution role arn role for the ecs task: "
+      @execution_role_arn = $stdin.gets.strip
+    end
+
     def override_source_paths(*paths)
       # Using string with instance_eval because block doesnt have access to
       # path at runtime.

data/lib/ufo/ship.rb

@@ -5,7 +5,6 @@ module Ufo
   class ShipmentOverridden < UfoError; end
 
   class Ship
-    include Default
     include AwsService
     include Util
 
@@ -209,16 +208,14 @@ module Ufo
         options = {
           cluster: @cluster,
           service_name: @service,
-          desired_count: default_desired_count,
-          deployment_configuration: {
-            maximum_percent: default_maximum_percent,
-            minimum_healthy_percent: default_minimum_healthy_percent
-          },
           task_definition: @task_definition
         }
+        options = options.merge(default_params[:create_service])
         unless target_group.nil? || target_group.empty?
           add_load_balancer!(container, options, target_group)
         end
+        puts "Creating ECS service with params:"
+        display_params(options)
         response = ecs.create_service(options)
         service = response.service # must set service here since this might never be called if @wait_for_deployment is false
       end
@@ -248,6 +245,9 @@ module Ufo
           service: ecs_service.service_arn, # can use the service name also since it is unique
           task_definition: @task_definition
         }
+        params = params.merge(default_params[:update_service] || {})
+        puts "Updating ECS service with params:"
+        display_params(params)
         response = ecs.update_service(params)
         service = response.service # must set service here since this might never be called if @wait_for_deployment is false
       end