ufo 3.5.7 → 4.0.0

data/lib/ufo/init.rb

@@ -1,23 +1,23 @@
 module Ufo
   class Init < Sequence
-    add_runtime_options! # force, pretend, quiet, skip options
-      # https://github.com/erikhuda/thor/blob/master/lib/thor/actions.rb#L49
+    include Network::Helper
 
     # Ugly, this is how I can get the options from to match with this Thor::Group
     def self.cli_options
       [
         [: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."],
+        [:image, required: true, desc: "Docker image name without the tag. Example: tongueroo/demo-ufo. Configures ufo/settings.yml"],
+        [:app, desc: "App name. Preferably one word. Used in the generated ufo/task_definitions.rb.  If not specified then the app name is inferred as the folder name."],
         [: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."],
+        [:vpc_id, desc: "Vpc id. For settings/network/default.yml."],
+        [:ecs_subnets, type: :array, desc: "Subnets for ECS tasks, defaults to --elb-subnets set to. For settings/network/default.yml"],
+        [:elb_subnets, type: :array, desc: "Subnets for ELB. For settings/network/default.yml"],
       ]
     end
-    cli_options.each do |args|
-      class_option *args
-    end
+    cli_options.each { |o| class_option(*o) }
 
     def setup_template_repo
       return unless @options[:template]&.include?('/')
@@ -48,26 +48,29 @@ module Ufo
       FileUtils.cd(dest)
     end
 
+    def set_network_options
+      configure_network_settings
+    end
+
     def init_files
       # map variables
-      @app = options[:app]
+      @app = options[:app] || inferred_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)/
-
-      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
+      exclude_pattern = File.exist?("#{Ufo.root}/Dockerfile") ?
+                          /(\.git|Dockerfile)/ :
+                          /(\.git)/
+      directory ".", exclude_pattern: exclude_pattern
     end
 
     def upsert_gitignore
       text =<<-EOL
-.ufo/output
+.ufo/current
 .ufo/data
+.ufo/log
+.ufo/output
 EOL
       if File.exist?(".gitignore")
         append_to_file ".gitignore", text
@@ -77,9 +80,7 @@ EOL
     end
 
     def upsert_dockerignore
-      text =<<-EOL
-.ufo
-EOL
+      text = ".ufo\n"
       if File.exist?(".dockerignore")
         append_to_file ".dockerignore", text
       else
@@ -90,18 +91,30 @@ EOL
     def user_message
       puts "Starter ufo files created."
       puts <<-EOL
+Congrats 🎉 You have successfully set up ufo for your project.
 #{"="*64}
-Congrats 🎉 You have successfully set up ufo for your project. To deploy to ECS:
 
-  ufo ship #{@app}-web
+## Task Definition Customizations
 
 If you need to customize the ECS task definition to configure things like memory and cpu allocation. You can do this by adjusting the files the .ufo/variables folder. These variables get applied to the .ufo/templates/main.json.erb task definition json that is passed to the ECS register task definition api.
 
 Some additional starter example roles for your apps were set up in in .ufo/task_definitions.rb.  Be sure to check it out and adjust it for your needs.
 
-This allows you to fully customize and control your environment to fit your application's needs.
+## Settings files
+
+Additionally, ufo generated starter settings files at that further allow you to customize more settings.
+
+* .ufo/settings.yml: general settings.
+* .ufo/settings/cfn/default.yml: properties of CloudFormation resources that ufo creates.
+* .ufo/settings/network/default.yml: network settings.
+
+More more info refer to: http://ufoships.com/docs/settings/
+
+To deploy to ECS:
+
+  ufo current --service #{@app}-web
+  ufo ship
 
-More info: http://ufoships.com
 EOL
     end
   end

data/lib/ufo/log_group.rb

@@ -9,7 +9,7 @@ module Ufo
     end
 
     def create
-      puts "Ensuring log group for #{@task_definition} exists"
+      puts "Ensuring log group for #{@task_definition.colorize(:green)} task definition exists"
       return if @options[:noop]
 
       Ufo.check_task_definition!(@task_definition)
@@ -17,6 +17,7 @@ module Ufo
       task_def["containerDefinitions"].each do |container_def|
         begin
           log_group_name = container_def["logConfiguration"]["options"]["awslogs-group"]
+          puts "Log group name: #{log_group_name}"
         rescue NoMethodError
           # silence when the logConfiguration is not specified
         end

data/lib/ufo/network.rb

@@ -0,0 +1,24 @@
+module Ufo
+  class Network < Command
+    autoload :Init, "ufo/network/init"
+    autoload :Helper, "ufo/network/helper"
+    autoload :Fetch, "ufo/network/fetch"
+
+    def self.cli_options
+      [
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
+        [:subnets, type: :array, desc: "Subnets"],
+        [:vpc_id, desc: "Vpc id"],
+        [:filename, default: "default", desc: "Name of the settings file to create w/o extension."],
+      ]
+    end
+
+    cli_options.each { |o| option(*o) }
+
+    desc "init", "Creates network starter settings file."
+    long_desc Help.text("network:init")
+    def init
+      Init.start
+    end
+  end
+end

data/lib/ufo/network/fetch.rb

@@ -0,0 +1,41 @@
+# Provides access to default network settings for a vpc: subnets and security_group
+# If no @vpc_id is provided to the initializer then the default vpc is used.
+class Ufo::Network
+  class Fetch
+    include Ufo::AwsService
+    extend Memoist
+
+    def initialize(vpc_id)
+      @vpc_id = vpc_id
+    end
+
+    def vpc_id
+      return @vpc_id if @vpc_id
+
+      resp = ec2.describe_vpcs(filters: [
+        {name: "isDefault", values: ["true"]}
+      ])
+      resp.vpcs.first.vpc_id
+    end
+    memoize :vpc_id
+
+    # all subnets
+    def subnet_ids
+      resp = ec2.describe_subnets(filters: [
+        {name: "vpc-id", values: [vpc_id]}
+      ])
+      resp.subnets.map(&:subnet_id).sort
+    end
+    memoize :subnet_ids
+
+    # default security group
+    def security_group_id
+      resp = ec2.describe_security_groups(filters: [
+        {name: "vpc-id", values: [vpc_id]},
+        {name: "group-name", values: ["default"]}
+      ])
+      resp.security_groups.first.group_id
+    end
+    memoize :security_group_id
+  end
+end

data/lib/ufo/network/helper.rb

@@ -0,0 +1,23 @@
+class Ufo::Network
+  module Helper
+    private
+    # for balancer default profile
+    def configure_network_settings
+      @options = @options.dup
+      return test_network_settings if ENV['TEST']
+
+      fetch = Fetch.new(@options[:vpc_id])
+      @options[:vpc_id] ||= fetch.vpc_id
+      @options[:ecs_subnets] ||= fetch.subnet_ids
+      @options[:elb_subnets] ||= fetch.subnet_ids
+    end
+
+    # hack for specs
+    def test_network_settings
+      @options[:vpc_id] = "vpc-111"
+      @options[:ecs_subnets] = ["subnet-111", "subnet-222"]
+      @options[:elb_subnets] = ["subnet-111", "subnet-222"]
+      @options
+    end
+  end
+end

data/lib/ufo/network/init.rb

@@ -0,0 +1,26 @@
+module Ufo
+  class Network::Init < Thor::Group
+    include Thor::Actions
+    include Network::Helper
+
+    add_runtime_options! # force, pretend, quiet, skip options
+      # https://github.com/erikhuda/thor/blob/master/lib/thor/actions.rb#L49
+
+    # Interesting, when defining the options in this class it screws up the ufo balance -h menu
+    Network.cli_options.each do |o|
+      class_option *o
+    end
+    def self.source_paths
+      [File.expand_path("../../../template/.ufo/settings/network", __FILE__)]
+    end
+
+    def set_network_options
+      configure_network_settings
+    end
+
+    def starter_files
+      filename = @options[:filename] || "default"
+      template "default.yml", ".ufo/settings/network/#{filename}.yml"
+    end
+  end
+end

data/lib/ufo/param.rb

@@ -1,5 +1,4 @@
 require 'yaml'
-require 'memoist'
 
 module Ufo
   class Param
@@ -13,7 +12,8 @@ module Ufo
       upgrade_message!
 
       result = RenderMePretty.result(@params_path, context: template_scope)
-      YAML.load(result)
+      data = YAML.load(result) || {}
+      data.deep_symbolize_keys
     end
     memoize :data
 
@@ -24,15 +24,15 @@ module Ufo
     # Ufo version 3.3 to 3.4 added a concept of a .ufo/params.yml file to support
     # fargate: https://github.com/tongueroo/ufo/pull/31
     #
-    # Warn user and tell them to run the `ufo upgrade3_3_to_3_4` command to upgrade.
+    # Warn user and tell them to run the `ufo upgrade v3_3to3_4` command to upgrade.
     def upgrade_message!
       return if File.exist?(@params_path)
 
       puts "ERROR: Your project is missing the .ufo/params.yml.".colorize(:red)
-      puts "This was added in ufo version 3.4 for Fargate support: https://github.com/tongueroo/ufo/pull/31"
+      puts "This was added in ufo version 3.4"
       puts "You can find more info about the params file here: http://ufoships.com/docs/params/"
       puts "To upgrade run:"
-      puts "  ufo upgrade3_3_to_3_4"
+      puts "  ufo upgrade v3_3to3_4"
       exit 1
     end
   end

data/lib/ufo/ps.rb

@@ -0,0 +1,102 @@
+require 'text-table'
+
+module Ufo
+  class Ps < Base
+    autoload :Task, 'ufo/ps/task'
+
+    delegate :service, to: :info
+
+    def run
+      unless service
+        puts no_service_message
+        return
+      end
+
+      summary
+      if task_arns.empty?
+        puts "There are 0 running tasks."
+        return
+      end
+
+      resp = ecs.describe_tasks(tasks: task_arns, cluster: @cluster)
+      display_info(resp)
+
+      display_scale_help
+      display_target_group_help
+    end
+
+    def summary
+      return unless @options[:summary]
+      puts "=> Service: #{@pretty_service_name}"
+      puts "   Service name: #{service.service_name}"
+      puts "   Status: #{service.status}"
+      puts "   Running count: #{service.running_count}"
+      puts "   Desired count: #{service.desired_count}"
+      puts "   Launch type: #{service.launch_type}"
+      puts "   Task definition: #{service.task_definition.split('/').last}"
+      elb = info.load_balancer(service)
+      if elb
+        puts "   Elb: #{elb.dns_name}"
+        puts "   Elb type: #{elb.type}"
+      end
+      puts "   Route53: #{info.route53_dns}" if info.route53_dns
+    end
+
+    def display_target_group_help
+      events = service["events"][0..4]
+      return if events[0].message =~ /has reached a steady state/
+
+      # The error currently happens to be the 5th element.
+      #
+      # Example:
+      #  "(service XXX) (instance i-XXX) (port 32875) is unhealthy in (target-group arn:aws:elasticloadbalancing:us-east-1:111111111111:targetgroup/devel-Targe-1111111111111/1111111111111111) due to (reason Health checks failed with these codes: [400])">]
+      error_event = events.find do |e|
+        e.message =~ /is unhealthy in/ &&
+        e.message =~ /targetgroup/
+      end
+      return unless error_event
+
+      puts "There are targets the target group reporting unhealthy.  This can cause containers to cycle. Here's the error:"
+      puts error_event.message.colorize(:red)
+      puts "Check out the ECS console events tab for more info."
+    end
+
+    # If the running count less than the desired account yet, check the events
+    # and show a message with helpful debugging information.
+    def display_scale_help
+      return if service.running_count >= service.desired_count
+
+      events = service["events"][0..3] # only check most recent 4 messages
+      error_event = events.find do |e|
+        e.message =~ /was unable to place a task/
+      end
+      return unless error_event
+
+      puts "There is an issue scaling the #{@service.colorize(:green)} service to #{service.desired_count}.  Here's the error:"
+      puts error_event.message.colorize(:red)
+    end
+
+    def display_info(resp)
+      table = Text::Table.new
+      table.head = Task.header
+      resp["tasks"].each do |t|
+        task = Task.new(t)
+        table.rows << task.to_a unless task.hide?
+      end
+      puts table
+    end
+
+    def task_arns
+      threads, results = [], {}
+      statuses = %w[RUNNING PENDING STOPPED]
+      statuses.each do |status|
+        threads << Thread.new do
+          resp = ecs.list_tasks(service_name: service.service_name, cluster: @cluster, desired_status: status)
+          results[status] = resp.task_arns
+        end
+      end
+      threads.map(&:join)
+      results.values.flatten.uniq
+    end
+  end
+end

data/lib/ufo/ps/task.rb

@@ -0,0 +1,78 @@
+class Ufo::Ps
+  class Task
+    def self.header
+      %w[Id Name Release Started Status Notes]
+    end
+
+    def initialize(task)
+      @task = task
+    end
+
+    def to_a
+      [id, name, release, started, status, notes]
+    end
+
+    def id
+      @task['task_arn'].split('/').last.split('-').first
+    end
+
+    def name
+      @task["overrides"]["container_overrides"].first["name"]
+    rescue NoMethodError
+      @task["containers"].first["name"]
+    end
+
+    def release
+      @task["task_definition_arn"].split('/').last
+    end
+
+    def started
+      started = Time.parse(@task["started_at"].to_s)
+      relative_time(started)
+    rescue ArgumentError
+      "PENDING"
+    end
+
+    def started_at
+      Time.parse(@task["started_at"].to_s)
+    rescue ArgumentError
+      nil
+    end
+
+    # hide stopped tasks that are older than 10 minutes
+    def hide?
+      status == "STOPPED" && started_at < Time.now - 60 * 10
+    end
+
+    def status
+      @task["last_status"]
+    end
+
+    def notes
+      return unless @task["stopped_reason"]
+
+      if @task["stopped_reason"] =~ /Task failed ELB health checks/
+        "Failed ELB health check"
+      else
+        @task["stopped_reason"]
+      end
+    end
+
+    # https://stackoverflow.com/questions/195740/how-do-you-do-relative-time-in-rails/195894
+    def relative_time(start_time)
+      diff_seconds = Time.now - start_time
+      case diff_seconds
+        when 0 .. 59
+          "#{diff_seconds.to_i} seconds ago"
+        when 60 .. (3600-1)
+          "#{(diff_seconds/60).to_i} minutes ago"
+        when 3600 .. (3600*24-1)
+          "#{(diff_seconds/3600).to_i} hours ago"
+        when (3600*24) .. (3600*24*30)
+          "#{(diff_seconds/(3600*24)).to_i} days ago"
+        else
+          start_time.strftime("%m/%d/%Y")
+      end
+    end
+  end
+end