ufo 3.5.7 → 4.0.0

data/lib/ufo/stack.rb

@@ -0,0 +1,203 @@
+# CloudFormation status codes, full list:
+#   https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html
+#
+#   CREATE_COMPLETE
+#   ROLLBACK_COMPLETE
+#   DELETE_COMPLETE
+#   UPDATE_COMPLETE
+#   UPDATE_ROLLBACK_COMPLETE
+#
+#   CREATE_FAILED
+#   DELETE_FAILED
+#   ROLLBACK_FAILED
+#   UPDATE_ROLLBACK_FAILED
+#
+#   CREATE_IN_PROGRESS
+#   DELETE_IN_PROGRESS
+#   REVIEW_IN_PROGRESS
+#   ROLLBACK_IN_PROGRESS
+#   UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
+#   UPDATE_IN_PROGRESS
+#   UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
+#   UPDATE_ROLLBACK_IN_PROGRESS
+#
+module Ufo
+  class Stack
+    autoload :Context, "ufo/stack/context"
+    autoload :Helper, "ufo/stack/helper"
+    autoload :Status, "ufo/stack/status"
+    extend Memoist
+    include Helper
+
+    def initialize(options)
+      @options = options
+      @task_definition = options[:task_definition]
+      @service = options[:service]
+      @cluster = @options[:cluster] || default_cluster
+      @stack_name = adjust_stack_name(@cluster, options[:service])
+    end
+
+    def deploy
+      @stack = find_stack(@stack_name)
+      if @stack && rollback_complete?(@stack)
+        puts "Existing stack in ROLLBACK_COMPLETE state. Deleting stack before continuing."
+        cloudformation.delete_stack(stack_name: @stack_name)
+        @status.wait
+        @status.reset
+        @stack = nil # at this point stack has been deleted
+      end
+
+      exit_with_message(@stack) if @stack && !updatable?(@stack)
+
+      @stack ? perform(:update) : perform(:create)
+
+      stop_old_tasks if @options[:stop_old_task]
+
+      return unless @options[:wait]
+      status.wait
+
+      puts status.rollback_error_message if status.update_rollback?
+
+      status.success?
+    end
+
+    def perform(action)
+      puts "#{action[0..-2].capitalize}ing stack #{@stack_name.colorize(:green)}..."
+      # Example: cloudformation.send("update_stack", stack_options)
+      cloudformation.send("#{action}_stack", stack_options)
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      handle_stack_error(e)
+    end
+
+    # do not memoize template_body it can change for a rename retry
+    def template_body
+      custom_template = "#{Ufo.root}/.ufo/settings/cfn/stack.yml"
+      path = if File.exist?(custom_template)
+               custom_template
+             else
+               # built-in default
+               File.expand_path("../cfn/stack.yml", File.dirname(__FILE__))
+             end
+      RenderMePretty.result(path, context: context.scope)
+    end
+
+    def stack_options
+      save_template
+      if ENV['SAVE_TEMPLATE_EXIT']
+        puts "Template saved. Exiting."
+        exit 1
+      end
+      {
+        parameters: parameters,
+        stack_name: @stack_name,
+        template_body: template_body,
+      }
+    end
+
+    def parameters
+      create_elb, elb_target_group = context.elb_options
+
+      network = Setting::Profile.new(:network, settings[:network_profile]).data
+      # pp network
+      elb_subnets = network[:elb_subnets] && !network[:elb_subnets].empty? ?
+                    network[:elb_subnets] :
+                    network[:ecs_subnets]
+
+      hash = {
+        Vpc: network[:vpc],
+        ElbSubnets: elb_subnets.join(','),
+        EcsSubnets: network[:ecs_subnets].join(','),
+
+        CreateElb: create_elb,
+        ElbTargetGroup: elb_target_group,
+        ElbEipIds: context.elb_eip_ids,
+
+        EcsDesiredCount: current_desired_count,
+        EcsTaskDefinition: task_definition_arn,
+      }
+
+      hash[:EcsSecurityGroups] = network[:ecs_security_groups].join(',') if network[:ecs_security_groups]
+      hash[:ElbSecurityGroups] = network[:elb_security_groups].join(',') if network[:elb_security_groups]
+
+      hash.map do |k,v|
+        if v == :use_previous_value
+          { parameter_key: k, use_previous_value: true }
+        else
+          { parameter_key: k, parameter_value: v }
+        end
+      end
+    end
+    memoize :parameters
+
+    def context
+      Context.new(@options.merge(
+        cluster: @cluster,
+        stack_name: @stack_name,
+        stack: @stack,
+      ))
+    end
+    memoize :context
+
+    def current_desired_count
+      info = Info.new(@service, @options)
+      service = info.service
+      if service
+        service.desired_count.to_s
+      else
+        "1" # new service default
+      end
+    end
+
+    def task_definition_arn
+      resp = ecs.describe_task_definition(task_definition: @task_definition)
+      resp.task_definition.task_definition_arn
+    end
+    memoize :task_definition_arn
+
+    # Store template in tmp in case for debugging
+    def save_template
+      path = "/tmp/ufo/#{@stack_name}/stack.yml"
+      FileUtils.mkdir_p(File.dirname(path))
+      IO.write(path, template_body)
+      puts "Generated template saved at: #{path}"
+
+      path = "/tmp/ufo/#{@stack_name}/parameters.yml"
+      IO.write(path, JSON.pretty_generate(parameters))
+      puts "Generated parameters saved at: #{path}"
+    end
+
+    def exit_with_message(stack)
+      region = `aws configure get region`.strip rescue "us-east-1"
+      url = "https://console.aws.amazon.com/cloudformation/home?region=#{region}#/stacks"
+      puts "The stack is not in an updateable state: #{stack.stack_status.colorize(:yellow)}."
+      puts "Here's the CloudFormation url to check for more details #{url}"
+      exit 1
+    end
+
+    # Assume only first container_definition to get the container info.
+    # Stack:arn:aws:cloudformation:... is in ROLLBACK_COMPLETE state and can not be updated.
+    def handle_stack_error(e)
+      case e.message
+      when /is in ROLLBACK_COMPLETE state and can not be updated/
+        puts "The #{@stack_name} stack is in #{"ROLLBACK_COMPLETE".colorize(:red)} and cannot be updated. Deleted the stack and try again."
+        region = `aws configure get region`.strip rescue 'us-east-1'
+        url = "https://console.aws.amazon.com/cloudformation/home?region=#{region}"
+        puts "Here's the CloudFormation console url: #{url}"
+        exit 1
+      when /No updates are to be performed/
+        puts "There are no updates to be performed. Exiting.".colorize(:yellow)
+        exit 1
+      else
+        raise
+      end
+    end
+
+    def rollback_complete?(stack)
+      stack.stack_status == 'ROLLBACK_COMPLETE'
+    end
+
+    def updatable?(stack)
+      stack.stack_status =~ /_COMPLETE$/
+    end
+  end
+end

data/lib/ufo/stack/context.rb

@@ -0,0 +1,242 @@
+class Ufo::Stack
+  class Context
+    extend Memoist
+    include Helper
+
+    def initialize(options)
+      @options = options
+      @task_definition = options[:task_definition]
+      @service = options[:service]
+      # no need to adjust @cluster or @stack_name because it was adjusted in Stack#initialize
+      @cluster = options[:cluster]
+      @stack_name = options[:stack_name]
+
+      @stack = options[:stack]
+      @new_stack = !@stack
+    end
+
+    def scope
+      scope = Ufo::TemplateScope.new(Ufo::DSL::Helper.new, nil)
+      # Add additional variable to scope for CloudFormation template.
+      # Dirties the scope but needed.
+      vars = {
+        cluster: @cluster,
+        stack_name: @stack_name, # used in custom_properties
+        pretty_service_name: Ufo.pretty_service_name(@service),
+        container: container,
+        # elb options remember that their 'state'
+        create_elb: create_elb?, # helps set Ecs DependsOn
+        elb_type: elb_type,
+        subnet_mappings: subnet_mappings,
+        create_route53: create_elb? && cfn[:dns] && cfn[:dns][:name],
+        default_target_group_protocol: default_target_group_protocol,
+        default_listener_protocol: default_listener_protocol,
+      }
+      # puts "vars:".colorize(:cyan)
+      # pp vars
+      scope.assign_instance_variables(vars)
+      scope
+    end
+    memoize :scope
+
+    def default_target_group_protocol
+      return 'TCP' if elb_type == 'network'
+      'HTTP'
+      # cfn[:target_group][:port] == 443 ? 'HTTPS' : 'HTTP'
+    end
+
+    def default_listener_protocol
+      return 'TCP' if elb_type == 'network'
+      'HTTP'
+      # cfn[:listener][:port] == 443 ? 'HTTPS' : 'HTTP'
+    end
+
+    def container
+      resp = ecs.describe_task_definition(task_definition: @task_definition)
+      task_definition = resp.task_definition
+
+      container_def = task_definition["container_definitions"].first
+      requires_compatibilities = task_definition["requires_compatibilities"]
+      fargate = requires_compatibilities && requires_compatibilities == ["FARGATE"]
+      network_mode = task_definition["network_mode"]
+
+      mappings = container_def["port_mappings"] || []
+      unless mappings.empty?
+        port = mappings.first["container_port"]
+      end
+
+      result = {
+        name: container_def["name"],
+        fargate: fargate,
+        network_mode: network_mode, # awsvpc, bridge, etc
+      }
+      result[:port] = port if port
+      result
+    end
+    memoize :container
+
+    def create_elb?
+      create_elb, _ = elb_options
+      create_elb == "true" # convert to boolean
+    end
+
+    # if --elb is not set at all, so it's nil. Thhen it defaults to creating the
+    # load balancer if the ecs service has a container name "web".
+    #
+    # --elb '' - wont crete an elb
+    # --elb 'auto' - creates an elb
+    # --elb arn:... - wont create elb and use the existing target group
+    #
+    def elb_options
+      case @options[:elb]
+      when "auto", "true", "yes"
+        create_elb = "true"
+        elb_target_group = ""
+      when "false", "0", "no"
+        create_elb = "false"
+        elb_target_group = ""
+      when /^arn:aws:elasticloadbalancing.*targetgroup/
+        create_elb = "false"
+        elb_target_group = @options[:elb]
+      when "", nil
+        create_elb, elb_target_group = default_elb_options
+      else
+        puts "Invalid --elb option provided: #{@options[:elb].inspect}".colorize(:red)
+        puts "Exiting."
+        exit 1
+      end
+      [create_elb, elb_target_group]
+    end
+
+    def default_elb_options
+      # cannot use :use_previous_value because need to know the create_elb value to
+      # compile a template with the right DependsOn for the Ecs service
+      unless @new_stack
+        create_elb = get_parameter_value(@stack, "CreateElb")
+        elb_target_group = get_parameter_value(@stack, "ElbTargetGroup")
+        return [create_elb, elb_target_group]
+      end
+
+      # default is to create the load balancer is if container name is web
+      # and no --elb option is provided
+      create_elb = container[:name] == "web" ? "true" : "false"
+      elb_target_group = ""
+      [create_elb, elb_target_group]
+    end
+
+    def get_parameter_value(stack, key)
+      param = stack.parameters.find do |p|
+        p.parameter_key == key
+      end
+      param.parameter_value
+    end
+
+    def reset_empty_eip_ids?
+      # reset and remove eip allocation ids check
+      @options[:elb_eip_ids] && @options[:elb_eip_ids].detect { |x| [' ', 'empty'].include?(x) }
+    end
+
+    def subnet_mappings
+      return [] if reset_empty_eip_ids?
+
+      elb_eip_ids = normalize_elb_eip_ids
+      return build_subnet_mappings!(elb_eip_ids) unless elb_eip_ids.empty?
+
+      unless @new_stack
+        elb_eip_ids = get_parameter_value(@stack, "ElbEipIds").split(',')
+        build_subnet_mappings(elb_eip_ids)
+      end
+    end
+
+    def normalize_elb_eip_ids
+      elb_eip_ids = @options[:elb_eip_ids] || []
+      elb_eip_ids.uniq!
+      elb_eip_ids
+    end
+
+    # Returns string, used as CloudFormation parameter.
+    def elb_eip_ids
+      return '' if reset_empty_eip_ids?
+
+      elb_eip_ids = normalize_elb_eip_ids
+      return elb_eip_ids.join(',') unless elb_eip_ids.empty?
+
+      unless @new_stack
+        return get_parameter_value(@stack, "ElbEipIds")
+      end
+
+      ''
+    end
+
+    def build_subnet_mappings!(allocations)
+      unless allocations.size == network[:elb_subnets].size
+        # puts "caller:".colorize(:cyan)
+        # puts caller
+        puts "ERROR: The allocation_ids must match in length to the subnets.".colorize(:red)
+        puts "Please double check that .ufo/settings/network/#{settings[:network_profile]} has the same number of subnets as the eip allocation ids are you specifying."
+        subnets = network[:elb_subnets]
+        puts "Conigured subnets: #{subnets.inspect}"
+        puts "Specified allocation ids: #{allocations.inspect}"
+        exit 1
+      end
+
+      build_subnet_mappings(allocations)
+    end
+
+    def build_subnet_mappings(allocations)
+      mappings = []
+      allocations.sort.each_with_index do |allocation_id, i|
+        mappings << [allocation_id, network[:elb_subnets][i]]
+      end
+      mappings
+    end
+
+    def elb_type
+      # if option explicitly specified then change the elb type
+      return @options[:elb_type] if @options[:elb_type]
+      # user is trying to create a network load balancer if --elb-eip-ids is used
+      elb_eip_ids = normalize_elb_eip_ids
+      if !elb_eip_ids.empty?
+        return "network"
+      end
+
+      # if not explicitly set, new stack will defeault to application load balancer
+      if @new_stack # default for new stack
+        return "application"
+      end
+
+      # find existing load balancer for type
+      resp = cloudformation.describe_stack_resources(stack_name: @stack_name)
+      resources = resp.stack_resources
+      elb_resource = resources.find do |resource|
+        resource.logical_resource_id == "Elb"
+      end
+
+      # In the case when stack exists and there is no elb resource, the elb type
+      # doesnt really matter because the elb wont be created since the CreateElb
+      # parameter is set to false. The elb type only needs to be set for the
+      # template to validate.
+      return "application" unless elb_resource
+
+      resp = elb.describe_load_balancers(load_balancer_arns: [elb_resource.physical_resource_id])
+      load_balancer = resp.load_balancers.first
+      load_balancer.type
+    end
+    memoize :elb_type
+
+    def network
+      Ufo::Setting::Profile.new(:network, settings[:network_profile]).data
+    end
+    memoize :network
+
+    def cfn
+      Ufo::Setting::Profile.new(:cfn, settings[:cfn_profile]).data
+    end
+    memoize :cfn
+
+    def settings
+      Ufo.settings
+    end
+
+  end
+end

data/lib/ufo/stack/helper.rb

@@ -0,0 +1,28 @@
+class Ufo::Stack
+  module Helper
+    include Ufo::AwsService
+    include Ufo::Util
+    extend Memoist
+
+    def find_stack(stack_name)
+      resp = cloudformation.describe_stacks(stack_name: stack_name)
+      resp.stacks.first
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      # example: Stack with id demo-web does not exist
+      if e.message =~ /Stack with/ && e.message =~ /does not exist/
+        nil
+      else
+        raise
+      end
+    end
+
+    def adjust_stack_name(cluster, service)
+      [cluster, Ufo.pretty_service_name(service)].compact.join('-')
+    end
+
+    def status
+      Status.new(@stack_name)
+    end
+    memoize :status
+  end
+end