ufo 4.0.3 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e87e363feef7f56793f6fe3b7e09b4c702eeedbc82535eae4233e2c79b68950
-  data.tar.gz: 8ff17b4dab22f9c92bec4de7248d75689f472813934ef9d51e16f13d7800d2bd
+  metadata.gz: 3e32cfe7ae9d1c54917cfca857b135fd1ad7dccc7f865ccc9f2b7187238c0b62
+  data.tar.gz: 39a546c17315befed8fcc630f382a613556b756e3ccd74e11fe20dc3a768d4c1
 SHA512:
-  metadata.gz: 5506d4b6023131bacb147e7f297314fd82504721125dbd27b7f059f8461b9680a83576d835d71426dbeaa7823b049f742c51aa59df8567631b285d663773d86b
-  data.tar.gz: aba58a3f64b8c17fec69eec866734941ddacbf8c5a72b8da576a8c5b4839bb36a7fcb4ecc1f9fa78d9c1328eef201cd358618571d13a9c105489470dbaf0f4e5
+  metadata.gz: ca820a40d91b2983413dfbf33d0a0ee31971f04e989711a827c413fa8708dc51c507e97bf5f889e094ab7b3d65a7dbc53001148fc59b716b6224e6a5ace17d73
+  data.tar.gz: 89856c014555a1685b101c62da4ee7b585197da7dcfe2ee113a79a857ef98ad6933eb66802a903b7f48ed0429ecaf9a3276afeeaf087dedcc001d7c3926e030c

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.
 
+## [4.1.0]
+- Merge pull request #46 from tongueroo/ufo-status
+- add ufo status command
+- ufo ps --extra option
+- update docs
+
 ## [4.0.3]
 - fix ufo ps for stopped task
 - improve docs

data/docs/_docs/ecs-network-mode.md

@@ -0,0 +1,24 @@
+---
+title: ECS Network Mode
+---
+
+## Pros and Cons: awsvpc vs bridge network mode
+
+With network bridge mode, the Docker containers of multiple services share the EC2 container instance's security group. So you have less granular control over opening ports for specific services only. For example, let’s say service A and B both are configured use bridge network mode. If you open up port 3000 for service A, it will also open up port 3000 for service B because they use the same security group at the EC2 instance level.
+
+One advantage of bridge mode is you can use dynamic port mapping and do not have to worry about network card limits.
+
+With awsvpc network mode, you must consider the limit of ethernet cards for the instance type. The table that lists the limits are under section the aws EC2 docs under [IP Addresses Per Network Interface Per Instance Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) For example, a t2.large instance has a limit of 3 ethernet cards. This means, at most, you can run 3 ECS tasks on that instance in awsvpc network mode.  The network card limit ranges from 3 to 15 ethernet cards depending on the instance type.
+
+The advantage of awsvpc mode is that since the ECS task has its own network card and security group, there’s more granular control of the permissions per ECS service. For example, when service A and B are using awsvpc mode, they can have different security groups associated with them. In this mode, ufo creates a security group and sets up the permissions so the load balancer can talk to the containers.  You can also add additional security group to the `.ufo/settings/network/default.yml` config.
+
+The following table summarizes the pros and cons:
+
+Network mode | Pros | Cons
+--- | ---
+bridge | The numbers of containers you can run will not be limited due to EC2 instance network cards limits. | Less fine grain security control over security group permissions with multiple ECS services.
+awsvpc | Fine grain security group permissions for each ECS service. | The number of containers can be limited by the number of network cards the EC2 instance type supports.
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/security-groups.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/ssl-support.md %}">Next Step</a>
+<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_docs/load-balancer.md

@@ -21,20 +21,30 @@ Here are examples of each of them:
     # Disable creating ELB
     ufo ship demo-web --elb=false
 
-## ELB Retained
+## Web Service Convention
 
-Ufo retains the ELB setting.  So future `ufo ship` commands will not suddenly remove the load balancer.  If you need to change the elb setting, then you need to explicitly set a new `--elb` value.
+By convention, if the container name is 'web' in the task definition. Deployments of new services will automatically create a load balancer.  So if the task definition looks something like the following then a load balancer will automatically be created:
 
-Important: Adding and removing load balancers will change the ELB DNS.  Please take pre-caution using the elb options.  This risk is mitigated if you have configured [Route53 support]({% link _docs/route53-support.md %}).
+```json
+{
+    "containerDefinitions": [
+        {
+            "name": "web",
+...
+```
 
-## Web Service Convention
-
-By convention, if the container name is 'web' in the task definition. Deployments of new services will automatically create a load balancer.  The behavior can be disabled with `--elb=false` for web containers.
+The behavior can be disabled with `--elb=false` for web containers.
 
     ufo ship demo-web --elb=false
 
 For non-web container the `--elb` option must be explicitly set to `--elb=true` if you want a load balancer to be created.
 
+## ELB Retained
+
+Ufo retains the ELB setting.  So future `ufo ship` commands will not suddenly remove the load balancer.  If you need to change the elb setting, then you need to explicitly set a new `--elb` value.
+
+Important: Adding and removing load balancers will change the ELB DNS.  Please take pre-caution using the elb options.  This risk is mitigated if you have configured [Route53 support]({% link _docs/route53-support.md %}).
+
 ## ELB Types: Application and Network
 
 Ufo supports application and network load balancer types.  To specify the type use `--elb-type`.  Examples:
@@ -61,6 +71,8 @@ To remove the EIPs but still keep the network load balancer, you can specify eit
     UFO_FORCE_TARGET_GROUP=1 ufo deploy demo-web --elb-eip-ids ' ' --elb-type network
     UFO_FORCE_TARGET_GROUP=1 ufo deploy demo-web --elb-eip-ids 'empty' --elb-type network
 
+Note be careful using the UFO_FORCE_TARGET_GROUP option. If the deploy fails, then the CloudFormation stack rolls back and can leave the target group with healthy targets resulting in downtime. If it's an production service and you are changing the load balancer type or eip IPs, it is recommended to instead create a temporary additional ECS service, do a DNS switch, and then remove the old ECS.
+
 ## Load Balancer Implementation
 
 Under the hood, ufo implements load balancer support with CloudFormation. You can see these resources by visiting the CloudFormation console and clicking on the corresponding stack.  Here's an example:

data/docs/_docs/security-groups.md

@@ -32,23 +32,6 @@ In general, ports below 32768 are outside of the ephemeral port range. So an eas
 
 If you are using a network load balancer and are running bridge network mode, then you need to whitelist ports 32768 to 65535 to `0.0.0.0/0`.  This is because network load balancers operate at layer 4 of the OSI model and cannot be assigned security groups, so they use the security group of the instance.  If you feel this is too loose of permissions, you can use awsvpc mode. There are some considerations for awsvpc mode though which is discussed next.
 
-## Pros and Cons: awsvpc vs bridge network mode
-
-With network bridge mode, the Docker containers of multiple services share the EC2 container instance's security group. So you have less granular control over opening ports for specific services only. For example, let’s say service A and B both are configured use bridge network mode. If you open up port 3000 for service A, it will also open up port 3000 for service B because they use the same security group at the EC2 instance level.
-
-One advantage of bridge mode is you can use dynamic port mapping and do not have to worry about network card limits.
-
-With awsvpc network mode, you must consider the limit of ethernet cards for the instance type. The table that lists the limits are under section the aws EC2 docs under [IP Addresses Per Network Interface Per Instance Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) For example, a t2 large instance has a limit of 3 Ethernet cards. This means, at most, you can run 3 ECS tasks on that instance in awsvpc network mode.
-
-The advantage of awsvpc mode is that since the ECS task has its own network card and security group, there’s more granular control of the permissions per ECS service. For example, when service A and B are using awsvpc mode, they can have different security groups associated with them. In this mode, ufo creates a security group and sets up the permissions so the load balancer can talk to the containers.  You can also add additional security group to the `.ufo/settings/network/default.yml` config.
-
-The following table summarizes the pros and cons:
-
-Network mode | Pros | Cons
---- | ---
-bridge | The numbers of containers you can run will not be limited due to EC2 instance network cards limits. | Less fine grain security control over security group permissions with multiple ECS services.
-awsvpc | Fine grain security group permissions for each ECS service. | The number of containers can be limited by the number of network cards the EC2 instance type supports.
-
 <a id="prev" class="btn btn-basic" href="{% link _docs/load-balancer.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ssl-support.md %}">Next Step</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/ecs-network-mode.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_docs/ssl-support.md

@@ -36,6 +36,6 @@ target_group:
 
 The protocol in the case of the network load balancer is TCP and is configured to TCP by default by ufo for Network Load Balancers, so you don't have to configure the protocol.
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/security-groups.md %}">Back</a>
+<a id="prev" class="btn btn-basic" href="{% link _docs/ecs-network-mode.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/route53-support.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_docs/upgrade4.md

@@ -8,7 +8,7 @@ A major change in ufo from version 3 to 4 is that the ECS service is now created
 
 The upgrade path recommended here should result in zero downtime. It is effectively a blue/green deployment with a DNS switchover.
 
-1. Run `ufo upgrade v3to4`
+1. Run `ufo upgrade v3to4` in your project folder.
 2. Check the changed files.
 3. Run `ufo ship SERVICE`.
 4. Confirm your new service is working. `ufo ps` and `ufo apps` is useful.

data/docs/_includes/subnav.html

@@ -27,6 +27,7 @@
                 <li><a href="{% link _docs/ufo-current.md %}">Ufo Current</a></li>
                 <li><a href="{% link _docs/load-balancer.md %}">Load Balancer</a></li>
                 <li><a href="{% link _docs/security-groups.md %}">Security Groups</a></li>
+                <li><a href="{% link _docs/ecs-network-mode.md %}">ECS Network Mode</a></li>
                 <li><a href="{% link _docs/ssl-support.md %}">SSL Support</a></li>
                 <li><a href="{% link _docs/route53-support.md %}">Route53 Support</a></li>
                 <li><a href="{% link _docs/faq.md %}">FAQ</a></li>

data/docs/_includes/ufo-ship-options.md

@@ -2,7 +2,7 @@
 Option  | Description
 ------------- | -------------
 `--cluster`  | This decides what cluster to use.  This can also be set in ufo/settings.yml covered in [Settings]({% link _docs/settings.md %}).  The cli option takes highest precedence.
-`--ecr-keep`  | This integer option determines how many old docker images to keep around.  Ufo will automatically delete and clean up docker images at the end of this process. The default is reasonable large at 30.
+`--ecr-keep`  | This integer option determines how many old docker images to keep around.  Ufo will automatically delete and clean up docker images at the end of this process. The default is to keep all.  If you set this, set it at a reasonable high number like 30.
 `--elb-eip-ids` | EIP Allocation ids to use for network load balancer.  If specified then `--elb-type` is automatically assumed to be `network`.
 `--elb-type` |  ELB type: application or network. Keep current deployed elb type when not specified.
 `--elb` | Decides to create elb, not create elb or use existing target group.

data/lib/ufo.rb

@@ -36,6 +36,7 @@ module Ufo
   autoload :Setting, 'ufo/setting'
   autoload :Ship, 'ufo/ship'
   autoload :Stack, 'ufo/stack'
+  autoload :Status, 'ufo/status'
   autoload :Stop, 'ufo/stop'
   autoload :Task, 'ufo/task'
   autoload :Tasks, 'ufo/tasks'

data/lib/ufo/cli.rb

@@ -156,6 +156,7 @@ module Ufo
     desc "ps SERVICE", "Show process info on ECS service."
     long_desc Help.text(:ps)
     option :summary, type: :boolean, default: true, desc: "Display summary header info."
+    option :extra, type: :boolean, default: false, desc: "Display extra debugging columns."
     def ps(service=:current)
       Ps.new(service, options).run
     end
@@ -172,6 +173,12 @@ module Ufo
       Stop.new(service, options).run
     end
 
+    desc "status SERVICE", "Status of ECS service.  Essentially, status of CloudFormation stack"
+    long_desc Help.text(:status)
+    def status(service=:current)
+      Status.new(service, options).run
+    end
+
     desc "completion *PARAMS", "Prints words for auto-completion."
     long_desc Help.text("completion")
     def completion(*params)

data/lib/ufo/current.rb

@@ -94,7 +94,7 @@ EOL
 Example:
     ufo #{ARGV.first} SERVICE
 You can also set a current service to be remembered with:
-    ufo current SERVICE
+    ufo current --service SERVICE
 EOL
       exit 1
       # if want to display full help menu:

data/lib/ufo/destroy.rb

@@ -14,8 +14,12 @@ module Ufo
 
       cloudformation.delete_stack(stack_name: @stack_name)
       puts "Deleting CloudFormation stack with ECS resources: #{@stack_name}."
+
       return unless @options[:wait]
+      start_time = Time.now
       status.wait
+      took = Time.now - start_time
+      puts "Time took for deletion: #{status.pretty_time(took).green}."
     end
 
     def are_you_sure?

data/lib/ufo/ps.rb

@@ -19,7 +19,7 @@ module Ufo
       end
 
       resp = ecs.describe_tasks(tasks: task_arns, cluster: @cluster)
-      display_info(resp)
+      display_tasks(resp)
 
       display_scale_help
       display_target_group_help
@@ -74,12 +74,17 @@ module Ufo
 
       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)
+      if service.launch_type == "EC2"
+        puts "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_info(resp)
+    def display_tasks(resp)
       table = Text::Table.new
+      Task.extra_columns = @options[:extra]
       table.head = Task.header
-      resp["tasks"].each do |t|
+      tasks = resp["tasks"].sort_by { |t| t["task_arn"] }
+      tasks.each do |t|
         task = Task.new(t)
         table.rows << task.to_a unless task.hide?
       end

data/lib/ufo/ps/task.rb

@@ -1,7 +1,9 @@
 class Ufo::Ps
   class Task
     def self.header
-      %w[Id Name Release Started Status Notes]
+      header = %w[Id Name Release Started Status Notes]
+      header << "Container Instance" if extra_columns
+      header
     end
 
     def initialize(task)
@@ -9,7 +11,9 @@ class Ufo::Ps
     end
 
     def to_a
-      [id, name, release, started, status, notes]
+      row = [id, name, release, started, status, notes]
+      row << container_instance_arn if extra_columns
+      row
     end
 
     def id
@@ -22,6 +26,10 @@ class Ufo::Ps
       @task["containers"].first["name"]
     end
 
+    def container_instance_arn
+      @task['container_instance_arn']
+    end
+
     def release
       @task["task_definition_arn"].split('/').last
     end
@@ -78,5 +86,18 @@ class Ufo::Ps
           start_time.strftime("%m/%d/%Y")
       end
     end
+
+    @@extra_columns = false
+    def self.extra_columns=(val)
+      @@extra_columns = val
+    end
+
+    def self.extra_columns
+      @@extra_columns
+    end
+
+    def extra_columns
+      self.class.extra_columns
+    end
   end
 end

data/lib/ufo/stack/status.rb

@@ -29,6 +29,7 @@ class Ufo::Stack
     include Ufo::Util
 
     attr_reader :events
+    attr_writer :hide_time_took
     def initialize(stack_name)
       @stack_name = stack_name
       reset
@@ -64,6 +65,7 @@ class Ufo::Stack
         puts "Stack success status: #{last_event_status}".colorize(:green)
       end
 
+      return unless @hide_time_took
       took = Time.now - start_time
       puts "Time took for stack deployment: #{pretty_time(took).green}."
     end

data/lib/ufo/status.rb

@@ -0,0 +1,56 @@
+module Ufo
+  class Status < Base
+    # used for the ufo status command
+    def run
+      unless stack_exists?(@stack_name)
+        puts "The stack #{@stack_name.colorize(:green)} does not exist."
+        return
+      end
+
+      resp = cloudformation.describe_stacks(stack_name: @stack_name)
+      stack = resp.stacks.first
+
+      puts "The current status for the stack #{@stack_name.colorize(:green)} is #{stack.stack_status.colorize(:green)}"
+
+      status_poller = Stack::Status.new(@stack_name)
+
+      if stack.stack_status =~ /_IN_PROGRESS$/
+        puts "Stack events (tailing):"
+        # tail all events until done
+        status_poller.hide_time_took = true
+        status_poller.wait
+      else
+        puts "Stack events:"
+        # show the last events that was user initiated
+        status_poller.refresh_events
+        status_poller.show_events(true)
+      end
+    end
+
+    def stack_exists?(stack_name)
+      return true if ENV['TEST']
+      return false if @options[:noop]
+
+      exist = nil
+      begin
+        # When the stack does not exist an exception is raised. Example:
+        # Aws::CloudFormation::Errors::ValidationError: Stack with id blah does not exist
+        resp = cloudformation.describe_stacks(stack_name: stack_name)
+        exist = true
+      rescue Aws::CloudFormation::Errors::ValidationError => e
+        if e.message =~ /does not exist/
+          exist = false
+        elsif e.message.include?("'stackName' failed to satisfy constraint")
+          # Example of e.message when describe_stack with invalid stack name
+          # "1 validation error detected: Value 'instance_and_route53' at 'stackName' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/._+]*"
+          puts "Invalid stack name: #{stack_name}"
+          puts "Full error message: #{e.message}"
+          exit 1
+        else
+          raise # re-raise exception  because unsure what other errors can happen
+        end
+      end
+      exist
+    end
+  end
+end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "4.0.3"
+  VERSION = "4.1.0"
 end

data/ufo.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Ufo::VERSION
   spec.authors       = ["Tung Nguyen"]
   spec.email         = ["tongueroo@gmail.com"]
-  spec.summary       = "Build Docker Containers and Ship Them to AWS ECS"
+  spec.summary       = "AWS ECS Deployment Tool"
   spec.homepage      = "http://ufoships.com"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.1.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-07 00:00:00.000000000 Z
+date: 2018-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -293,6 +293,7 @@ files:
 - docs/_docs/automated-cleanup.md
 - docs/_docs/conventions.md
 - docs/_docs/customize-cloudformation.md
+- docs/_docs/ecs-network-mode.md
 - docs/_docs/faq.md
 - docs/_docs/fargate.md
 - docs/_docs/helpers.md
@@ -527,6 +528,7 @@ files:
 - lib/ufo/stack/context.rb
 - lib/ufo/stack/helper.rb
 - lib/ufo/stack/status.rb
+- lib/ufo/status.rb
 - lib/ufo/stop.rb
 - lib/ufo/task.rb
 - lib/ufo/tasks.rb
@@ -590,7 +592,7 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Build Docker Containers and Ship Them to AWS ECS
+summary: AWS ECS Deployment Tool
 test_files:
 - spec/fixtures/apps/describe_services.json
 - spec/fixtures/cfn/stack-events-complete.json