ufo 3.3.2 → 3.4.0

data/lib/ufo/task.rb

@@ -1,6 +1,6 @@
 module Ufo
   class Task
-    include Default
+    include Util
     include AwsService
 
     def initialize(task_definition, options)
@@ -12,15 +12,23 @@ module Ufo
     def run
       puts "Running task_definition: #{@task_definition}".colorize(:green) unless @options[:mute]
       return if @options[:noop]
+
       task_options = {
         cluster: @cluster,
         task_definition: @task_definition
       }
+      task_options = task_options.merge(default_params[:run_task] || {})
+
       if @options[:command]
         task_options.merge!(overrides: overrides)
         puts "Running task with container overrides."
         puts "Command: #{@options[:command].join(' ')}"
       end
+
+      unless @options[:mute]
+        puts "Running task with params:"
+        display_params(task_options)
+      end
       resp = ecs.run_task(task_options)
       puts "Task ARN: #{resp.tasks[0].task_arn}" unless @options[:mute]
     end

data/lib/ufo/tasks/register.rb

@@ -3,6 +3,7 @@ require 'json'
 
 module Ufo
   class Tasks::Register
+    include Util
     include AwsService
 
     def self.register(task_name, options={})
@@ -28,11 +29,30 @@ module Ufo
       if @options[:noop]
         message = "NOOP: #{message}"
       else
-        ecs.register_task_definition(data)
+        register_task_definition(data)
       end
       puts message unless @options[:mute]
     end
 
+    def register_task_definition(data)
+      if ENV["UFO_SHOW_REGISTER_TASK_DEFINITION"]
+        puts "Registering task definition with:"
+        display_params(data)
+      end
+
+      ecs.register_task_definition(data)
+    rescue Aws::ECS::Errors::ClientException => e
+      if e.message =~ /No Fargate configuration exists for given values/
+        puts "ERROR: #{e.message}".colorize(:red)
+        puts "Configured values are: cpu #{data[:cpu]} memory #{data[:memory]}"
+        puts "Check that the cpu and memory values are a supported combination by Fargate."
+        puts "More info: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-cpu-memory-error.html"
+        exit 1
+      else
+        raise
+      end
+    end
+
     # LogConfiguration requires a string with dashes as the keys
     # https://docs.aws.amazon.com/sdkforruby/api/Aws/ECS/Client.html
     def fix_log_configuation_option(data)

data/lib/ufo/template_scope.rb

@@ -0,0 +1,45 @@
+module Ufo
+  class TemplateScope
+    attr_reader :helper
+    def initialize(helper=nil)
+      @helper = helper
+      load_variables_file("base")
+      load_variables_file(Ufo.env)
+    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)
+    end
+
+    def assign_instance_variables
+      # copy over the instance variables to make available in 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
+  end
+end

data/lib/ufo/upgrade/params.yml

@@ -0,0 +1,47 @@
+<%%
+  # replace with actual values:
+  @subnets = ["subnet-111","subnet-222"]
+  @security_groups = ["sg-111"]
+%>
+# These params are passsed to the corresponding aws-sdk ecs client methods.
+# AWS Docs example: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Client.html#run_task-instance_method
+#
+# Comments left in as examples.
+# Uncomment launch_type and network_configuration sections to enable fargate.
+#
+
+create_service:
+  deployment_configuration:
+    maximum_percent: 200
+    minimum_healthy_percent: 100
+  desired_count: 1
+  # launch_type: "FARGATE"
+  # network_configuration:
+  #   awsvpc_configuration:
+  #     subnets: <%%= @subnets.inspect %> # required
+  #     security_groups: <%%= @security_groups.inspect %>
+  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+
+# update service is provide as an example below.  Though it is probably better
+# to not add any options to update_service if you are using the ECS console
+# to update these settings often.
+update_service:
+  # force_new_deployment: true
+  # deployment_configuration:
+  #   maximum_percent: 200
+  #   minimum_healthy_percent: 100
+  # desired_count: 1
+  # launch_type: "FARGATE"
+  # network_configuration:
+  #   awsvpc_configuration:
+  #     subnets: <%%= @subnets.inspect %> # required
+  #     security_groups: <%%= @security_groups.inspect %>
+  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+
+run_task:
+  # launch_type: "FARGATE"
+  # network_configuration:
+  #   awsvpc_configuration:
+  #     subnets: <%%= @subnets.inspect %> # required
+  #     security_groups: <%%= @security_groups.inspect %>
+  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED

data/lib/ufo/upgrade33_to_34.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+require 'yaml'
+
+module Ufo
+  class Upgrade33_to_34
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      if File.exist?("#{Ufo.root}/.ufo/params.yml")
+        puts "It looks like you already have a .ufo/params.yml project. This is the new project structure so exiting without updating anything."
+        return
+      end
+
+      create_params_yaml
+      warn_about_removing_new_service_from_settings
+    end
+
+    def create_params_yaml
+      src = File.expand_path("./upgrade/params.yml", File.dirname(__FILE__))
+      dest = "#{Ufo.root}/.ufo/params.yml"
+      FileUtils.cp(src, dest)
+      puts "File .ufo/params.yml created.".colorize(:green)
+      puts "Please check it out and adjust it to your needs."
+    end
+
+    def warn_about_removing_new_service_from_settings
+      puts "WARN: The new_service option is not longer a part of the .ufo/settings.yml.  Please remove it.  It is now a part of the .ufo/params.yml file."
+    end
+  end
+end

data/lib/ufo/util.rb

@@ -1,5 +1,26 @@
+require 'active_support/core_ext/hash'
+
 module Ufo
   module Util
+    # The default cluster normally defaults to the Ufo.env value.
+    # But it can be overriden by ufo/settings.yml cluster
+    #
+    # More info: http://ufoships.com/docs/settings/
+    def default_cluster
+      settings["cluster"] || Ufo.env
+    end
+
+    # Keys are strings for simplicity.
+    def settings
+      @settings ||= Setting.new.data
+    end
+
+    # Naming it default_params because params is too commonly used in ufo.
+    # Param keys must be symbols for the aws-sdk calls.
+    def default_params
+      @default_params ||= Param.new.data.deep_symbolize_keys
+    end
+
     def execute(command, local_options={})
       if @options[:noop] && !local_options[:live]
         say "NOOP: #{command}"
@@ -24,5 +45,9 @@ module Ufo
         "#{minutes.to_i}m #{seconds.to_i}s"
       end
     end
+
+    def display_params(options)
+      puts YAML.dump(options.deep_stringify_keys)
+    end
   end
 end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "3.3.2"
+  VERSION = "3.4.0"
 end

data/spec/fixtures/settings.yml

@@ -4,10 +4,6 @@ base:
   # clean_keep: 30 # cleans up docker images on your docker server.
   # ecr_keep: 30 # cleans up images on ECR and keeps this remaining amount. Defaults to keep all.
   # 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/spec/lib/setting_spec.rb

@@ -5,8 +5,8 @@ describe Ufo::Setting do
 
   let(:setting) { Ufo::Setting.new }
 
-  it "includes base into other environments automatically" do
-    count = setting.data["new_service"]["desired_count"]
-    expect(count).to eq 1
+  it "includes the cluster setting" do
+    cluster = setting.data["cluster"]
+    expect(cluster).to eq "dev"
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 ENV["TEST"] = "1"
-# Ensures aws api never called. Fixture home folder does not contain ~/.aws/credentails
+# Ensures aws api never called. Fixture home does not contain ~/.aws/credentials
 ENV['HOME'] = "spec/fixtures/home"
 
 # CodeClimate test coverage: https://docs.codeclimate.com/docs/configuring-test-coverage

data/ufo.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "aws-sdk-elasticloadbalancingv2"
   spec.add_dependency "colorize"
   spec.add_dependency "deep_merge"
+  spec.add_dependency "memoist"
   spec.add_dependency "plissken"
   spec.add_dependency "render_me_pretty"
   spec.add_dependency "thor"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.4.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatchlogs
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  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: plissken
   requirement: !ruby/object:Gem::Requirement
@@ -254,6 +268,7 @@ files:
 - docs/_docs/install.md
 - docs/_docs/migrations.md
 - docs/_docs/next-steps.md
+- docs/_docs/params.md
 - docs/_docs/run-in-pieces.md
 - docs/_docs/settings.md
 - docs/_docs/single-task.md
@@ -319,6 +334,7 @@ files:
 - docs/_reference/ufo-tasks-register.md
 - docs/_reference/ufo-tasks.md
 - docs/_reference/ufo-upgrade3.md
+- docs/_reference/ufo-upgrade3_3_to_3_4.md
 - docs/_reference/ufo-version.md
 - docs/articles.md
 - docs/bin/web
@@ -356,10 +372,12 @@ files:
 - docs/style.css
 - exe/ufo
 - lib/template/.env
+- lib/template/.ufo/params.yml.tt
 - lib/template/.ufo/settings.yml.tt
 - lib/template/.ufo/task_definitions.rb.tt
+- lib/template/.ufo/templates/fargate.json.erb
 - lib/template/.ufo/templates/main.json.erb
-- lib/template/.ufo/variables/base.rb
+- lib/template/.ufo/variables/base.rb.tt
 - lib/template/.ufo/variables/development.rb
 - lib/template/.ufo/variables/production.rb
 - lib/template/Dockerfile
@@ -372,7 +390,6 @@ files:
 - lib/ufo/completer/script.rb
 - lib/ufo/completer/script.sh
 - lib/ufo/core.rb
-- lib/ufo/default.rb
 - lib/ufo/default/settings.yml
 - lib/ufo/default/templates/main.json.erb
 - lib/ufo/deploy.rb
@@ -415,6 +432,7 @@ files:
 - lib/ufo/help/tasks/register.md
 - lib/ufo/init.rb
 - lib/ufo/log_group.rb
+- lib/ufo/param.rb
 - lib/ufo/scale.rb
 - lib/ufo/sequence.rb
 - lib/ufo/setting.rb
@@ -423,7 +441,10 @@ files:
 - lib/ufo/tasks.rb
 - lib/ufo/tasks/builder.rb
 - lib/ufo/tasks/register.rb
+- lib/ufo/template_scope.rb
+- lib/ufo/upgrade/params.yml
 - lib/ufo/upgrade3.rb
+- lib/ufo/upgrade33_to_34.rb
 - lib/ufo/util.rb
 - lib/ufo/version.rb
 - spec/fixtures/home_existing/.aws/config

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

@@ -1,6 +0,0 @@
-# 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].
-@cpu = 128
-@memory_reservation = 256
-@environment = helper.env_file(".env")

data/lib/ufo/default.rb

@@ -1,40 +0,0 @@
-module Ufo
-  # To include this module must have this in initialize:
-  #
-  # def initialize(optiions, ...)
-  #   @options = options
-  #   ...
-  # end
-  #
-  # So @options must be set
-  module Default
-    # The default cluster normally defaults to the Ufo.env value.
-    # But it can be overriden by ufo/settings.yml cluster
-    #
-    # More info: http://ufoships.com/docs/settings/
-    def default_cluster
-      setting.data["cluster"] || Ufo.env
-    end
-
-    # These default service values only are used when a service is created by `ufo`
-    def default_maximum_percent
-      Integer(new_service_setting["maximum_percent"] || 200)
-    end
-
-    def default_minimum_healthy_percent
-      Integer(new_service_setting["minimum_healthy_percent"] || 100)
-    end
-
-    def default_desired_count
-      Integer(new_service_setting["desired_count"] || 1)
-    end
-
-    def new_service_setting
-      setting.data["new_service"] || {}
-    end
-
-    def setting
-      @setting ||= Setting.new
-    end
-  end
-end