ufo 6.0.0 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f7705c4016b08dd205ad9209ee255b6cd3411fea731183b6c859b28cf900990
-  data.tar.gz: 4eb918b33c3a87ed71fbc64e3a0dbac8766a02ccbf15d7e35b863a26f7fd78a3
+  metadata.gz: d3cfcec77698c26df14d0107993faaa4b6e74d235c269ff66b8750645db8103e
+  data.tar.gz: 9c5a5e8be3b5956ef6dabe22c4ddc792ca3edb9573d739821eb74378392e8ec2
 SHA512:
-  metadata.gz: c65f585f02f1a54afa5c3c2c0a36378e219b8490eec8321d1dd18f9cec4026108f39e11215d0ec964b1842dbca8ade66d4f7e0b256c41386f86eb0db60f931b2
-  data.tar.gz: 16226423b75d58394e9e92dcd4562629e9defc5ed46a2acad4e0f049deca9e0c525e2ddaec984eaac616edebe996c1e8e154f3ea3fbb73ae8dfd108bd68958cf
+  metadata.gz: e3fb6884204bb2110ac621bb63f6644ff4f60b66b84d9ca5aeaa6023276d629e0e61c43a6bb539051eb594b0c0ca6294a7e78b5e55db2fb7c51f2983c4da6fdb
+  data.tar.gz: 80fd898e6c89cb1ba1ebd3aa2f5eadd04f00b12bf6ac234bdaf9eb9b72d0f2e07490400262263aab07bba73e53e7706a8d8bffb5e3d542ab285ec8502f2dd335

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.1] - 2022-03-05
+- [#126](https://github.com/tongueroo/ufo/pull/126) ecs deployment_configuration options
+- [#127](https://github.com/tongueroo/ufo/pull/127) improve ps errors reporting
+
 ## [6.0.0] - 2022-03-05
 - [#125](https://github.com/tongueroo/ufo/pull/125) v6: major ufo upgrades and new structure
 

data/lib/ufo/cfn/stack/builder/resources/ecs_service.rb

@@ -14,6 +14,7 @@ class Ufo::Cfn::Stack::Builder::Resources
     def properties
       props = {
         Cluster: @cluster,
+        DeploymentConfiguration: deployment_configuration,
         DesiredCount: {
           "Fn::If": [
             "EcsDesiredCountIsBlank",
@@ -68,5 +69,17 @@ class Ufo::Cfn::Stack::Builder::Resources
 
       props
     end
+
+  private
+    def deployment_configuration
+      ecs = Ufo.config.ecs
+      return ecs.configuration if ecs.configuration # provide user full control
+
+      # default
+      {
+        MaximumPercent: ecs.maximum_percent,
+        MinimumHealthyPercent: ecs.minimum_healthy_percent,
+      }
+    end
   end
 end

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

@@ -17,10 +17,10 @@ Confirm to ship:
 
     Will deploy stack demo-web-dev (y/N) y
     Building Docker Image
-    => docker build -t 536766270177.dkr.ecr.us-west-2.amazonaws.com/demo:ufo-2022-03-02T20-32-33-12dc6e0 -f Dockerfile .
-    Docker Image built: 536766270177.dkr.ecr.us-west-2.amazonaws.com/demo:ufo-2022-03-02T20-32-33-12dc6e0
+    => docker build -t 111111111111.dkr.ecr.us-west-2.amazonaws.com/demo:ufo-2022-03-02T20-32-33-12dc6e0 -f Dockerfile .
+    Docker Image built: 111111111111.dkr.ecr.us-west-2.amazonaws.com/demo:ufo-2022-03-02T20-32-33-12dc6e0
     Pushing Docker Image
-    => docker push 536766270177.dkr.ecr.us-west-2.amazonaws.com/demo:ufo-2022-03-02T20-32-33-12dc6e0
+    => docker push 111111111111.dkr.ecr.us-west-2.amazonaws.com/demo:ufo-2022-03-02T20-32-33-12dc6e0
     Task Definition built: .ufo/output/task_definition.json
     Parameters built:      .ufo/output/params.json
     Template built:        .ufo/output/template.yml

data/lib/ufo/cli/logs.rb

@@ -16,7 +16,7 @@ class Ufo::CLI
 
     def find_log_group_name
       unless info.service
-        logger.info "Cannot find ECS service for #{@stack_name}"
+        logger.info "Cannot find stack: #{@stack_name}"
         exit 1
       end
       task_definition = info.service.task_definition

data/lib/ufo/cli/ps/errors.rb

@@ -0,0 +1,116 @@
+class Ufo::CLI::Ps
+  class Errors < Ufo::CLI::Ps
+    def initialize(options={})
+      super
+      @tasks = options[:tasks]
+    end
+
+    def show
+      message = recent_message
+      return unless message
+      return if message =~ /has reached a steady state/
+
+      scale
+      target_group
+      deployment_configuration
+      catchall
+    end
+
+    # If running count < desired account for a long time
+    # And see was unable to place a task
+    # Probably not enough capacity
+    def scale
+      return if service.running_count >= service.desired_count
+
+      error_event = recent_events.find do |e|
+        e.message =~ /was unable to place a task/
+      end
+      return unless error_event
+
+      logger.info "There is an issue scaling the #{@stack_name.color(:green)} service to #{service.desired_count}.  Here's the error:"
+      logger.info error_event.message.color(:red)
+      if service.launch_type == "EC2"
+        logger.info <<~EOL
+          If AutoScaling is set up for the container instances,
+          it can take a little time to add additional instances.
+          You'll see this message until the capacity is added.
+        EOL
+      end
+    end
+
+    # 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])">]
+    def target_group
+      error_event = recent_events.find do |e|
+        e.message =~ /is unhealthy in/ &&
+        e.message =~ /targetgroup/
+      end
+      return unless error_event
+
+      logger.error "There are targets in the target group reporting unhealthy.  This can cause containers to cycle. Here's the error:"
+      logger.error error_event.message.color(:red)
+      logger.error <<~EOL
+        Check out the ECS console and EC2 Load Balancer console for more info.
+        Sometimes they may not helpful :(
+        Docs that may help: https://ufoships.com/docs/debug/unhealthy-targets/
+      EOL
+    end
+
+    # To reproduce
+    #
+    # .ufo/config.rb
+    #
+    #     Ufo.configure do |config|
+    #       config.ecs.maximum_percent = 150 # need at least 200 to go from 1 to 2 containers
+    #       config.ecs.minimum_healthy_percent = 100
+    #     end
+    #
+    # Event message error:
+    #
+    #     ERROR: (service app1-web-dev-EcsService-8FMliG8m6M2p) was unable to stop or start tasks during a deployment because of the service deployment configuration. Update the minimumHealthyPercent or maximumPercent value and try again.
+    #
+    def deployment_configuration
+      message = recent_message
+      return unless message.include?("unable") && message.include?("deployment configuration")
+
+      logger.error "ERROR: Deployment Configuration".color(:red)
+      logger.error <<~EOL
+        You might have a Deployment Configuration that prevents the deployment from completing.
+
+        See: https://ufoships.com/docs/debug/deployment-configuration/
+
+      EOL
+    end
+
+    # Example:
+    #     (service app1-web-dev-EcsService-8FMliG8m6M2p) was unable to stop or start tasks during a deployment because of the service deployment configuration. Update the minimumHealthyPercent or maximumPercent value and try again.
+    def catchall
+      message = recent_message
+      words = %w[fail unable]
+      found = words.detect { |word| message.include?(word) }
+      return unless found
+      logger.error "ERROR: #{message}".color(:red)
+      logger.error <<~EOL
+        You might have to cancel the stack with:
+
+            ufo cancel
+
+        And try again after fixing the issue.
+      EOL
+    end
+
+  private
+    # only check a few most recent
+    def recent_events
+      service["events"][0..4]
+    end
+
+    def recent_message
+      recent = recent_events.first
+      return unless recent
+      recent.message ? recent.message : nil
+    end
+  end
+end

data/lib/ufo/cli/ps.rb

@@ -25,9 +25,9 @@ class Ufo::CLI
         resp["tasks"]
       end.flatten
 
-      display_tasks(all_task_arns)
-      display_scale_help
-      display_target_group_help
+      tasks = convert_to_task_objects(all_task_arns)
+      show_tasks(tasks)
+      show_errors(tasks)
     end
 
     def summary
@@ -63,50 +63,7 @@ class Ufo::CLI
       resp.scalable_targets.first # scalable_target
     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
-
-      logger.error "There are targets in the target group reporting unhealthy.  This can cause containers to cycle. Here's the error:"
-      logger.error error_event.message.color(:red)
-      logger.error <<~EOL
-        Check out the ECS console and EC2 Load Balancer console for more info.
-        Sometimes they may not helpful :(
-        Docs that may help: https://ufoships.com/docs/debug/unhealthy-targets/
-      EOL
-    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
-
-      logger.info "There is an issue scaling the #{@service.color(:green)} service to #{service.desired_count}.  Here's the error:"
-      logger.info error_event.message.color(:red)
-      if service.launch_type == "EC2"
-        logger.info "If AutoScaling is set up for the container instances, it can take a little time to add additional instances. You'll see this message until the capacity is added."
-      end
-    end
-
-    def display_tasks(raw_tasks)
-      raw_tasks.sort_by! { |t| t["task_arn"] }
-      tasks = raw_tasks.map { |t| Task.new(t) } # will have Task objects after this point
+    def show_tasks(tasks)
       tasks = tasks.reject(&:hide?)
       show_notes = show_notes(tasks)
 
@@ -124,6 +81,11 @@ class Ufo::CLI
       presenter.show
     end
 
+    def show_errors(tasks)
+      Errors.new(@options.merge(tasks: tasks)).show
+    end
+
+  private
     def show_notes(tasks)
       tasks.detect { |t| !t.notes.blank? }
     end
@@ -167,6 +129,11 @@ class Ufo::CLI
       status == "ALL" ? valid_statuses : [status]
     end
 
+    def convert_to_task_objects(task_arns)
+      task_arns.sort_by! { |t| t["task_arn"] }
+      task_arns.map { |t| Task.new(t) } # will have Task objects after this point
+    end
+
     def task_arns
       threads, results = [], {}
       statuses.each do |status|

data/lib/ufo/cli.rb

@@ -85,7 +85,8 @@ module Ufo
     long_desc Help.text(:ps)
     option :status, default: "all", desc: "Status filter: all, pending, stopped, running."
     # not setting format default so we can use Ufo.config.ps.format and dont want to trigger a config load this early
-    option :format, desc: "Output formats: #{CliFormat.formats.join(', ')}"
+    formats = CliFormat.formats + ["auto"]
+    option :format, desc: "Output formats: #{formats.sort.join(', ')}"
     def ps
       Ps.new(options).run
     end

data/lib/ufo/config.rb

@@ -49,7 +49,10 @@ module Ufo
 
       config.ecs = ActiveSupport::OrderedOptions.new
       config.ecs.cluster = ":ENV" # => dev
+      config.ecs.deployment_configuration = nil # full control
       config.ecs.desired_count = nil # only respected when config.autoscaling.enabled = false
+      config.ecs.maximum_percent = 200 # nil
+      config.ecs.minimum_healthy_percent = 100 # nil
       config.ecs.scheduling_strategy = "REPLICA"
 
       config.elb = ActiveSupport::OrderedOptions.new

data/lib/ufo/task_definition/helpers/vars.rb

@@ -65,8 +65,8 @@ module Ufo::TaskDefinition::Helpers
       end
     end
 
-    # arn:aws:ssm:us-west-2:536766270177:parameter/demo/dev/DB-NAME
-    # arn:aws:ssm:us-west-2:536766270177:parameter/demo/dev/DB-NAME
+    # arn:aws:ssm:us-west-2:111111111111:parameter/demo/dev/DB-NAME
+    # arn:aws:ssm:us-west-2:111111111111:parameter/demo/dev/DB-NAME
     def expansion(arn)
       # performance improvement only run names.expansion on the name portion
       md = arn.match(/(.*:)(parameter\/|secret:)(.*)/)

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "6.0.0"
+  VERSION = "6.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.0.1
 platform: ruby
 authors:
 - Tung Nguyen
@@ -518,6 +518,7 @@ files:
 - lib/ufo/cli/new/sequence.rb
 - lib/ufo/cli/opts.rb
 - lib/ufo/cli/ps.rb
+- lib/ufo/cli/ps/errors.rb
 - lib/ufo/cli/ps/task.rb
 - lib/ufo/cli/releases.rb
 - lib/ufo/cli/rollback.rb