ufo 6.0.5 → 6.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 731c8ef178a8fe9586b08eef48c7cdc4b1014e58b601155a46bed1f0c5657afa
-  data.tar.gz: 1654ffccfb5a57827b63e4cf8777f2ff0884e52a4e29ee0591296947443e8189
+  metadata.gz: 87344022dcbcd4b41904a181613e3eb4bbe8985577517d9633efb8f2b3795249
+  data.tar.gz: 7f3d119496e82275a92f0b8b867bb08025c76955de837b33cddb39bdc835466c
 SHA512:
-  metadata.gz: ebf9a0cbd7b7d2b532c85a8776180475d38ae5fdb4bd2b0dd1cc4ce93df3546b9af65385e3632cc936a0825e1252377c354ed4c409cb8f9723bcf0baa9a09134
-  data.tar.gz: '0913ec88f24b35bd34208cdbc286fcd1a1ad021538feebb66e7d9fff7bfb2eaeba7d902f5581a3003a1dc92f8a491b09bb9aab25fc0b21f4c788194c5b487f4a'
+  metadata.gz: 8964557bdb9b5a1958f22a3f72f6719de1c9a97fb2b5ca1e4b7961bc61cdb912817147246e86568c21ec2ba10fad0c9e5f5dc53c8bec2d6c92d86221df09711c
+  data.tar.gz: a12c83ff26e2b0177e2ec9311f07a71fe1b5f9689663e45fd6267edfe4570795c31aab9f6dc06d2e059ae37711bb0017f1a7fce995ad1532aea942d09bbe6961

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [6.0.6] - 2022-03-07
+- [#134](https://github.com/tongueroo/ufo/pull/134) config.autoscaling.manual_changes.retain support
+- change default `elb.healthy_threshold_count = 3`
+- change default `config.ship.docker.quiet = true`
+- config.autoscaling.manual_changes.retain support
+- fix yaml validator print code
+- ship cli help
+
 ## [6.0.5] - 2022-03-07
 - change default config.ship.docker.quiet = true
 

data/lib/templates/init/.ufo/config.rb.tt

@@ -4,36 +4,37 @@ Ufo.configure do |config|
   config.docker.repo = "<%= @repo %>"
   # config.ecs.cluster = ":ENV" # :ENV pattern is replaced with UFO_ENV. Default is UFO_ENV=dev
 
-  # See VPC Docs: https://ufoships.com/docs/config/vpc/
+  # VPC Docs: https://ufoships.com/docs/config/vpc/
   # When not set, it's assumed that the ECS cluster using default vpc and default subnets.
   # Notice the ability to use `stack_output` helpers to set the values.
   # config.vpc.id = stack_output("vpc-:ENV.Vpc")
   # config.vpc.subnets.ecs = stack_output("vpc-:ENV.PrivateAppSubnets").split(',')
   # config.vpc.subnets.elb = stack_output("vpc-:ENV.PublicSubnets").split(',')
 
-  # See AutoScaling Docs: https://ufoships.com/docs/features/autoscaling/
+  # AutoScaling Docs: https://ufoships.com/docs/features/autoscaling/
   # config.autoscaling.enabled = true
-  # config.autoscaling.min_capacity = 2
+  # config.autoscaling.manual_changes.retain = false
   # config.autoscaling.max_capacity = 3
+  # config.autoscaling.min_capacity = 2
   # config.autoscaling.target_value = 50.0
 
-  # See Route DNS Docs: https://ufoships.com/docs/features/dns-route53-support/
+  # Route DNS Docs: https://ufoships.com/docs/features/dns-route53-support/
   # config.dns.domain = "domain.com"
 
-  # See ufo exec Docs: https://ufoships.com/docs/intro/ufo-exec/
+  # Ufo exec Docs: https://ufoships.com/docs/intro/ufo-exec/
   # bash is default but may not be available your Docker image
   # Configure to /bin/sh if needed
-  # config.ecs.default_execute_command = "/bin/bash"
+  # config.exec.command = "/bin/bash"
 
-  # See: https://ufoships.com/docs/config/reference/
+  # Docs: https://ufoships.com/docs/config/reference/
   # config.ps.summary = false # false to turn off the summary at top of ufo ps output
   # config.ps.format = "table" # Examples: csv table tab json
 
-  # See: https://ufoships.com/docs/config/reference/
+  # Docs: https://ufoships.com/docs/config/reference/
   # Note: the `-` (minus sign) in front rejects the pattern
   # config.logs.filter_pattern = '- "HealthChecker"'
 
-  # See: https://ufoships.com/docs/config/reference/
+  # Docs: https://ufoships.com/docs/config/reference/
   # You may want to set to false if your docker build and push process takes a while
   # config.ship.docker.quiet = false # default is true.
 end

data/lib/ufo/aws_services.rb

@@ -103,6 +103,13 @@ module Ufo
       end
     end
 
+    def stack_resources(stack_name)
+      resp = cloudformation.describe_stack_resources(stack_name: stack_name)
+      resp.stack_resources
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      e.message.include?("does not exist") ? return : raise
+    end
+
     def task_definition_arns(family, max_items=10)
       resp = ecs.list_task_definitions(
         family_prefix: family,

data/lib/ufo/cfn/stack/builder/resources/scaling/target.rb

@@ -13,10 +13,35 @@ module Ufo::Cfn::Stack::Builder::Resources::Scaling
             - [service, #{@cluster}, !GetAtt [EcsService, Name]]
           ServiceNamespace: ecs
           ScalableDimension: ecs:service:DesiredCount
-          MinCapacity: #{autoscaling.min_capacity}
-          MaxCapacity: #{autoscaling.max_capacity}
+          MinCapacity: #{min_capacity}
+          MaxCapacity: #{max_capacity}
       EOL
       Ufo::Yaml.load(text).deep_symbolize_keys
     end
+
+  private
+    def min_capacity
+      return autoscaling.min_capacity if vars[:new_stack] && !autoscaling.manual_changes.retain
+      scalable_target ? scalable_target.min_capacity : autoscaling.min_capacity
+    end
+
+    def max_capacity
+      return autoscaling.max_capacity if vars[:new_stack] && !autoscaling.manual_changes.retain
+      scalable_target ? scalable_target.max_capacity : autoscaling.max_capacity
+    end
+
+    def scalable_target
+      resources = stack_resources(vars[:stack_name])
+      return unless resources
+      ecs_service = resources.find { |r| r.logical_resource_id == "EcsService" }
+      service_name = File.basename(ecs_service.physical_resource_id) # IE: demo-web-dev-EcsService-Tw0nPMgpkmm4
+      resource_id = "service/#{vars[:cluster]}/#{service_name}"
+      resp = applicationautoscaling.describe_scalable_targets(
+        service_namespace: "ecs",
+        resource_ids: [resource_id],
+      )
+      resp.scalable_targets.first
+    end
+    memoize :scalable_target
   end
 end

data/lib/ufo/cfn/stack/vars.rb

@@ -1,33 +1,41 @@
 class Ufo::Cfn::Stack
   class Vars < Ufo::Cfn::Base
     attr_reader :stack_name
-    def initialize(options={})
-      super
-      @cluster = options[:cluster].dup # Thor options are frozen, we thaw it because CustomProperties#substitute_variables does a sub!
-      @stack_name = options[:stack_name] || [Ufo.app, @task_definition.role, Ufo.env].join('-')
-      @stack = options[:stack]
-      @new_stack = !@stack
-    end
 
     def values
+      # Not passing stack down to vars beause its easier to debug. Will require another lookup by thats ok
       {
         cluster: @cluster,
-        stack_name: @stack_name, # used in custom_properties
         container: container,
-        # to reconstruct TaskDefinition in the CloudFormation template
-        task_definition: @task_definition,
-        rollback_task_definition: @options[:rollback_task_definition],
-        # elb options remember that their 'state'
         create_elb: create_elb?, # helps set Ecs DependsOn
-        elb_type: elb_type,
+        create_listener_ssl: create_listener_ssl?,
         create_route53: create_elb? && dns_configured?,
-        default_target_group_protocol: default_target_group_protocol,
         default_listener_protocol: default_listener_protocol,
         default_listener_ssl_protocol: default_listener_ssl_protocol,
-        create_listener_ssl: create_listener_ssl?,
+        default_target_group_protocol: default_target_group_protocol,
+        elb_type: elb_type,
+        new_stack: new_stack,
+        rollback_task_definition: rollback_task_definition,
+        stack_name: @stack_name, # used in custom_properties
+        task_definition: @task_definition, # to reconstruct TaskDefinition for CloudFormation template
       }
     end
 
+    def new_stack
+      !stack
+    end
+
+    # Find stack in vars to ensure both ufo build and ufo ship can tell if stack has already been built
+    def stack
+      find_stack(@stack_name)
+    end
+    memoize :stack
+
+    def rollback_task_definition
+      return unless @options[:rollback]
+      @options[:rollback_task_definition]
+    end
+
     def dns_configured?
       !!Ufo.config.dns.domain || !!Ufo.config.dns.name
     end

data/lib/ufo/cfn/stack.rb

@@ -78,35 +78,19 @@ module Ufo::Cfn
     end
 
     def build
-      options_with_vars = @options.dup.merge(vars: vars.values)
+      vars = Vars.new(@options).values
+      options_with_vars = @options.dup.merge(vars: vars)
       params = Params.new(options_with_vars)
       @parameters = params.build
       template = Template.new(options_with_vars)
       @template_body = template.body
     end
 
-    def vars
-      o = @options.merge(
-        cluster: @cluster,
-        stack_name: @stack_name,
-        stack: @stack,
-      )
-      o[:rollback_task_definition] = rollback_task_definition if rollback_task_definition
-      Vars.new(o)
-    end
-    memoize :vars
-
     def scheduling_strategy
       scheduling_strategy = Ufo.config.ecs.scheduling_strategy
       scheduling_strategy.upcase if scheduling_strategy
     end
 
-    def rollback_task_definition
-      return unless @options[:rollback]
-      @options[:rollback_task_definition]
-    end
-    memoize :rollback_task_definition
-
     def exit_with_message(stack)
       url = "https://console.aws.amazon.com/cloudformation/home?region=#{region}#/stacks"
       logger.info "The stack is not in an updateable state: #{stack.stack_status.color(:yellow)}."

data/lib/ufo/cli/help/ship.md

@@ -4,10 +4,6 @@ Here's an example:
 
     ufo ship
 
-Let's deploy
-
-    ufo ship
-
 You will be prompted to confirm before deployment.
 
     $ ufo ship

data/lib/ufo/cli/scale.rb

@@ -65,18 +65,21 @@ class Ufo::CLI
     end
 
     def warning
-      return unless Ufo.config.scale.warning
+      autoscaling = Ufo.config.autoscaling
+      return if autoscaling.manual_changes.warning == false or autoscaling.manual_changes.retain
       logger.info <<~EOL
         Note: The settings are temporary.
         They can be overwritten in the next `ufo ship` deploy.
-        To make the settings permanent update your ufo config.
 
-        See: https://ufoships.com/docs/config/
+        You can turn off this warning with
 
-        You can also turn off this warning with
+            config.autoscaling.warning = false
 
-            config.scale.warning = false
+        Or you can use the
 
+            config.autoscaling.manual_changes.retain = true
+
+        For considerations, see: https://ufoships.com/docs/features/autoscaling/
       EOL
     end
   end

data/lib/ufo/config.rb

@@ -21,6 +21,9 @@ module Ufo
 
       config.autoscaling = ActiveSupport::OrderedOptions.new
       config.autoscaling.enabled = true
+      config.autoscaling.manual_changes = ActiveSupport::OrderedOptions.new
+      config.autoscaling.manual_changes.retain = false
+      config.autoscaling.manual_changes.warning = true
       config.autoscaling.max_capacity = 5 # dont use max thats an OrderedOptions method
       config.autoscaling.min_capacity = 1 # dont use min thats an OrderedOptions method
       config.autoscaling.predefined_metric_type = "ECSServiceAverageCPUUtilization"
@@ -28,6 +31,7 @@ module Ufo
       config.autoscaling.scale_out_cooldown = nil
       config.autoscaling.target_value = 75.0
 
+
       config.cfn = ActiveSupport::OrderedOptions.new
       config.cfn.disable_rollback = nil
       config.cfn.notification_arns = nil
@@ -59,9 +63,9 @@ module Ufo
       config.elb.default_actions = nil # full override
       config.elb.enabled = "auto" # "auto", true or false
 
-      config.elb.health_check_interval_seconds = 10
+      config.elb.health_check_interval_seconds = 10 # keep at 10 in case of network ELB, which is min 10
       config.elb.health_check_path = nil # When nil its AWS default /
-      config.elb.healthy_threshold_count = 5
+      config.elb.healthy_threshold_count = 3 # The AWS usual default is 5
       config.elb.unhealthy_threshold_count = 2
 
       config.elb.port = 80 # default listener port
@@ -105,12 +109,9 @@ module Ufo
       config.secrets.pattern.ssm = ":APP/:ENV/:SECRET_NAME" # => demo/dev/DB_PASS
       config.secrets.provider = "ssm" # default provider for conventional expansion IE: ssm or secretsmanager
 
-      config.scale = ActiveSupport::OrderedOptions.new
-      config.scale.warning = true
-
       config.ship = ActiveSupport::OrderedOptions.new
       config.ship.docker = ActiveSupport::OrderedOptions.new
-      config.ship.docker.quiet = false # only affects ufo ship docker commands output
+      config.ship.docker.quiet = true # only affects ufo ship docker commands output
 
       config.state = ActiveSupport::OrderedOptions.new
       config.state.reminder = true

data/lib/ufo/info.rb

@@ -64,7 +64,7 @@ module Ufo
       dns_name = output.output_value if output
       return unless dns_name
 
-      ssl = stack_resources.detect.find do |r|
+      ssl = stack_resources.find do |r|
         r.logical_resource_id == "ListenerSsl"
       end
 

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "6.0.5"
+  VERSION = "6.0.6"
 end

data/lib/ufo/yaml/validator.rb

@@ -28,7 +28,7 @@ class Ufo::Yaml
       md = e.message.match(/at line (\d+) column (\d+)/)
       line = md[1].to_i
 
-      DslEvaluator.print_code(path, line_number)
+      DslEvaluator.print_code(path, line)
       exit 1
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 6.0.5
+  version: 6.0.6
 platform: ruby
 authors:
 - Tung Nguyen