ufo 3.5.7 → 4.0.0

data/lib/template/.ufo/params.yml.tt

@@ -1,66 +1,27 @@
-<%%
-  # replace with actual values if using fargate
-  @subnets = ["subnet-111","subnet-222"]
-  @security_groups = ["sg-111"]
-%>
 # These params are passsed to the corresponding aws-sdk ecs client methods.
 # AWS Docs example: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Client.html#run_task-instance_method
 #
-# Comments left in as examples.
-# Uncomment launch_type and network_configuration sections to enable fargate.
+# The network helper provides access to the .ufo/settings/network/[PROFILE].yml
 #
 # More docs: http://ufoships.com/docs/params/
 
-create_service:
-  deployment_configuration:
-    maximum_percent: 200
-    minimum_healthy_percent: 100
-  desired_count: 1
-<% if @options[:launch_type] == "fargate" -%>
-  launch_type: "FARGATE"
-  network_configuration:
-    awsvpc_configuration:
-      subnets: <%%= @subnets.inspect %> # required
-      security_groups: <%%= @security_groups.inspect %>
-      assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
-<% else -%>
-  # launch_type: "FARGATE"
-  # network_configuration:
-  #   awsvpc_configuration:
-  #     subnets: <%%= @subnets.inspect %> # required
-  #     security_groups: <%%= @security_groups.inspect %>
-  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
-<% end -%>
-
-# update service is provide as an example below.  Though it is probably better
-# to not add any options to update_service if you are using the ECS console
-# to update these settings often.
-update_service:
-  # force_new_deployment: true
-  # deployment_configuration:
-  #   maximum_percent: 200
-  #   minimum_healthy_percent: 100
-  # desired_count: 1
-  # launch_type: "FARGATE"
-  # network_configuration:
-  #   awsvpc_configuration:
-  #     subnets: <%%= @subnets.inspect %> # required
-  #     security_groups: <%%= @security_groups.inspect %>
-  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
-
-run_task:
-<% if @options[:launch_type] == "fargate" -%>
-  launch_type: "FARGATE"
-  network_configuration:
-    awsvpc_configuration:
-      subnets: <%%= @subnets.inspect %> # required
-      security_groups: <%%= @security_groups.inspect %>
-      assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
-<% else -%>
-  # launch_type: "FARGATE"
-  # network_configuration:
-  #   awsvpc_configuration:
-  #     subnets: <%%= @subnets.inspect %> # required
-  #     security_groups: <%%= @security_groups.inspect %>
-  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
-<% end -%>
+# ufo task calls run_tasks.
+#
+# ufo task will assign these values appropriately based on the task
+# definition being ran. So generally you should you can leave these settings
+# alone.
+#
+# If it's a Fargate task definition, ufo task automatically adds the
+# network_configuration and launch_type: FARGATE
+# If it's a EC2 task definition with awsvpc network mode, ufo task
+# automatically adds the network_configuration and security groups using
+# the security groups from .ufo/settings/network/default.yml.
+#
+# run_task:
+#   # network_configuration is required for FARGATE
+#   network_configuration:
+#     awsvpc_configuration:
+#       subnets: <%%= network[:ecs_subnets].inspect %> # required
+#       security_groups: <%%= network[:ecs_security_groups].inspect %>
+#       # for fargate use: assign_public_ip: ENABLED
+#       # assign_public_ip: ENABLED # accepts ENABLED, DISABLED

data/lib/template/.ufo/settings.yml.tt

@@ -6,7 +6,12 @@ base:
   image: <%= @image %>
   # clean_keep: 30
   # ecr_keep: 30
-  # defaults when an new ECS service is created by ufo ship
+  network_profile: default # .ufo/settings/network/default.yml file
+  cfn_profile: default # .ufo/settings/cfn/default.yml file
+  # If you want to have prettier name set for the ECS service name
+  # There are some cavaets with this. Updating properties on resources that require
+  # replacment might not work. For example, adding and removing a load balancer.
+  # In these cases, you must delete the entire ecs service and recreate it.
 
 development:
   # cluster: development

data/lib/template/.ufo/settings/cfn/default.yml.tt

@@ -0,0 +1,55 @@
+---
+# Options allow you to customize any resources that ufo creates with
+# CloudFormation. These options are inserting into the generated template.
+# More info: https://ufoships.com/docs/customize-cloudformation
+
+elb:
+  scheme: internet-facing
+
+# https://docs.aws.amazon.com/fr_fr/elasticloadbalancing/latest/APIReference/API_CreateTargetGroup.html
+#
+# When using SSL with network elb, the target group protocol is usually http still
+# unless you also handle SSL termination at the app level.
+target_group:
+  port: 80 # only used with ECS if awsvpc mode
+  # protocol: TCP # valid values - application elb: HTTP HTTPS, network elb: TCP
+                  # ufo sets defaults in cloudformation template
+                  #   application elb: HTTP
+                  #   network elb: TCP
+                  # so we can keep this commented out, unless we need HTTPS at the app level
+  target_group_attributes:
+  - key: deregistration_delay.timeout_seconds
+    value: 1
+  # network elb support health_check_interval_seconds of 10 or 30
+  # health_check_interval_seconds: 30
+
+  # health check settings are supported by application load balancer only:
+  # health_check_protocol: HTTP # HTTP or HTTPS
+  # health_check_path: /
+  # health_check_port: traffic-port
+  # unhealthy_threshold_count: 10
+
+# https://docs.aws.amazon.com/fr_fr/elasticloadbalancing/latest/APIReference/API_CreateListener.html
+#
+# If HTTPS and SSL is required this is where it would normally be set. Application ELBs
+# support SSL termination. Network load balancers do not.
+listener:
+  port: 80 # required by ufo, used in cloudformation template
+  # For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.
+  # protocol: TCP # valid values - application elb: HTTP HTTPS, network elb: TCP
+                  # ufo sets defaults in cloudformation template
+                  #   application elb: HTTP
+                  #   network elb: TCP
+                  # so we can keep this commented out, unless we need HTTPS at elb level
+  # certificates is required if using HTTPS protocol with application
+  # certificates:
+  # - certificate: arn:aws:acm:us-east-1:111111111111:certificate/11111111-2222-3333-4444-555555555555
+
+# Configure dns to automatically be associated with the ELB dns name.
+# Note, the route53 record set for the domain name must already exist.
+# The {stack_name} variable gets replaced with the name of the CloudFormation stack name.
+# Example: {stack_name} => demo-web
+# dns:
+#   name: "{stack_name}.yourdomain."
+#   hosted_zone_name: yourdomain. # dont forget the trailing period
+#   TTL: '60' # ttl has special upcase casing

data/lib/template/.ufo/settings/network/default.yml.tt

@@ -0,0 +1,18 @@
+---
+vpc: <%= @options[:vpc_id] %>
+ecs_subnets: # required: at least 2 subnets
+<% @options[:ecs_subnets].each do |subnet| -%>
+  - <%= subnet %>
+<% end -%>
+elb_subnets: # defaults to same subnets as ecs_subnets when not set
+<% @options[:elb_subnets].each do |subnet| -%>
+  - <%= subnet %>
+<% end -%>
+
+# Optional additional existing security group ids to add on top of the ones created
+# by ufo.
+# elb_security_groups:
+#   - sg-aaa
+# ecs_security_groups:
+#   - sg-bbb
+#   - sg-ccc

data/lib/template/.ufo/task_definitions.rb.tt

@@ -11,8 +11,9 @@
 #
 # More info: http://ufoships.com/docs/helpers/
 #
+<% source_name = @options[:launch_type] == "fargate" ? "fargate" : "main" -%>
 task_definition "<%= @app %>-web" do
-  source "main" # will use ufo/templates/main.json.erb
+  source "<%= source_name %>" # will use ufo/templates/<%= source_name %>.json.erb
   variables(
     family: task_definition_name,
     name: "web",
@@ -26,7 +27,7 @@ task_definition "<%= @app %>-web" do
     #   prefix-name/container-name/ecs-task-id
     # Here's an exmaple when you specify the prefix of "demo"
     #   demo/web/209e93b4-5523-4496-9a27-662fd151eb78
-    awslogs_group: "ecs/<%= @app %>-web",
+    awslogs_group: ["ecs/<%= @app %>-web", Ufo.env_extra].compact.join('-'),
     awslogs_stream_prefix: "<%= @app %>",
     awslogs_region: helper.current_region,
     # command: ["bin/web"] # IMPORTANT: change or create a bin/web file
@@ -34,12 +35,12 @@ task_definition "<%= @app %>-web" do
 end
 
 task_definition "<%= @app %>-worker" do
-  source "main" # will use ufo/templates/main.json.erb
+  source "<%= source_name %>" # will use ufo/templates/<%= source_name %>.json.erb
   variables(
     family: task_definition_name,
     name: "worker",
     # Comment out awslogs_* if you do not want logs to be sent to CloudWatch.
-    awslogs_group: "ecs/<%= @app %>-worker",
+    awslogs_group: ["ecs/<%= @app %>-worker", Ufo.env_extra].compact.join('-'),
     awslogs_stream_prefix: "<%= @app %>",
     awslogs_region: helper.current_region,
     # command: ["bin/worker"] # IMPORTANT: change or create a bin/worker file
@@ -47,12 +48,12 @@ task_definition "<%= @app %>-worker" do
 end
 
 task_definition "<%= @app %>-clock" do
-  source "main" # will use ufo/templates/main.json.erb
+  source "<%= source_name %>" # will use ufo/templates/<%= source_name %>.json.erb
   variables(
     family: task_definition_name,
     name: "clock",
     # Comment out awslogs_* if you do not want logs to be sent to CloudWatch.
-    awslogs_group: "ecs/<%= @app %>-clock",
+    awslogs_group: ["ecs/<%= @app %>-clock", Ufo.env_extra].compact.join('-'),
     awslogs_stream_prefix: "<%= @app %>",
     awslogs_region: helper.current_region,
     # command: ["bin/clock"] # IMPORTANT: change or create a bin/clock file

data/lib/template/.ufo/templates/fargate.json.erb

@@ -2,7 +2,7 @@
   "family": "<%= @family %>",
   "requiresCompatibilities": ["FARGATE"],
   "networkMode": "awsvpc",
-  "executionRoleArn": "<%= @execution_role_arn %>",
+  "executionRoleArn": "<%= @execution_role_arn || raise("@execution_role_arn needs to be set") %>",
   "cpu": "<%= @cpu %>",
   "memory": "<%= @memory %>",
   "containerDefinitions": [

data/lib/template/.ufo/templates/main.json.erb

@@ -1,5 +1,6 @@
 {
   "family": "<%= @family %>",
+<%#  "networkMode": "awsvpc", %>
   "containerDefinitions": [
     {
       "name": "<%= @name %>",

data/lib/template/.ufo/variables/base.rb.tt

@@ -1,6 +1,6 @@
 # Example ufo/variables/base.rb
 # More info on how variables work: http://ufoships.com/docs/variables/
-@image = helper.full_image_name # includes the git sha tongueroo/hi:ufo-[sha].
+@image = helper.full_image_name # includes the git sha tongueroo/demo-ufo:ufo-[sha].
 @environment = helper.env_file(".env")
 <% if @options[:launch_type] == "fargate" -%>
 # Ensure that the cpu and memory values are a supported combination by Fargate.
@@ -8,8 +8,11 @@
 <% end -%>
 @cpu = 256
 @memory = 512
-@memory_reservation = 256
+@memory_reservation = 512
 
 <% if @execution_role_arn_input -%>
 @execution_role_arn = "<%= @execution_role_arn_input %>"
+<% else -%>
+# required for fargate
+# @execution_role_arn = "..."
 <% end -%>

data/lib/template/Dockerfile

@@ -1,20 +1,15 @@
-FROM ruby:2.5.0
-MAINTAINER Tung Nguyen <tongueroo@gmail.com>
+FROM ruby:2.5.1
 
-# This is just a sample Dockerfile. This is meant to be overriden.
+WORKDIR /app
+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+RUN bundle install --system
 
-# Install bundle of gems first in a layer
-# so if the Gemfile doesnt chagne it wont have to install gems again
-WORKDIR /tmp
-COPY Gemfile* /tmp/
-RUN bundle install && rm -rf /root/.bundle/cache
+ADD . /app
+RUN bundle install --system
 
-# Add the Rails app
-ENV HOME /root
-WORKDIR /app
-COPY . /app
-RUN bundle install
-RUN mkdir -p tmp/cache tmp/pids
+EXPOSE 4567
 
-EXPOSE 5001
+# If you do not have a bin/web wrapper file, create one or update this command
+RUN chmod a+x bin/web
 CMD ["bin/web"]

data/lib/template/bin/deploy.tt

@@ -1,7 +1,7 @@
 #!/bin/bash -xe
 
-# Generated started bin/deploy script.  Meant to be example only and should probably
-# be overridden.
+# Generated starter bin/deploy script example.
+# Meant to be overridden.
 
 # Only build one docker image and deploys it to multiple ECS services
 ufo ships <%= @app %>-{web,clock,worker}

data/lib/ufo.rb

@@ -4,35 +4,44 @@ require 'deep_merge'
 require 'colorize'
 require 'fileutils'
 require 'render_me_pretty'
+require 'memoist'
 
 module Ufo
-  autoload :Core, 'ufo/core'
+  autoload :Apps, 'ufo/apps'
   autoload :AwsService, 'ufo/aws_service'
-  autoload :Command, 'ufo/command'
-  autoload :Setting, 'ufo/setting'
-  autoload :Util, 'ufo/util'
-  autoload :Init, 'ufo/init'
-  autoload :Sequence, 'ufo/sequence'
+  autoload :Base, 'ufo/base'
+  autoload :Cancel, 'ufo/cancel'
   autoload :CLI, 'ufo/cli'
-  autoload :Help, 'ufo/help'
-  autoload :Ship, 'ufo/ship'
-  autoload :Task, 'ufo/task'
+  autoload :Command, 'ufo/command'
+  autoload :Completer, "ufo/completer"
+  autoload :Completion, "ufo/completion"
+  autoload :Core, 'ufo/core'
+  autoload :Current, 'ufo/current'
   autoload :Destroy, 'ufo/destroy'
+  autoload :Docker, 'ufo/docker'
   autoload :DSL, 'ufo/dsl'
-  autoload :Scale, 'ufo/scale'
-  autoload :LogGroup, 'ufo/log_group'
+  autoload :Ecr, 'ufo/ecr'
   autoload :ECS, 'ufo/ecs'
+  autoload :Help, 'ufo/help'
+  autoload :Info, 'ufo/info'
+  autoload :Init, 'ufo/init'
+  autoload :LogGroup, 'ufo/log_group'
+  autoload :Network, 'ufo/network'
   autoload :Param, 'ufo/param'
-  autoload :TemplateScope, 'ufo/template_scope'
-
-  autoload :Docker, 'ufo/docker'
-  autoload :Ecr, 'ufo/ecr'
+  autoload :Ps, 'ufo/ps'
+  autoload :Releases, 'ufo/releases'
+  autoload :Rollback, 'ufo/rollback'
+  autoload :Scale, 'ufo/scale'
+  autoload :Sequence, 'ufo/sequence'
+  autoload :Setting, 'ufo/setting'
+  autoload :Ship, 'ufo/ship'
+  autoload :Stack, 'ufo/stack'
+  autoload :Stop, 'ufo/stop'
+  autoload :Task, 'ufo/task'
   autoload :Tasks, 'ufo/tasks'
-  autoload :Completion, "ufo/completion"
-  autoload :Completer, "ufo/completer"
-  autoload :Upgrade3, "ufo/upgrade3"
-  autoload :Upgrade33_to_34, "ufo/upgrade33_to_34"
+  autoload :TemplateScope, 'ufo/template_scope'
+  autoload :Upgrade, "ufo/upgrade"
+  autoload :Util, 'ufo/util'
 
   extend Core
 end
-

data/lib/ufo/apps.rb

@@ -0,0 +1,49 @@
+require 'text-table'
+
+module Ufo
+  class Apps
+    autoload :CfnMap, "ufo/apps/cfn_map"
+    autoload :Service, "ufo/apps/service"
+
+    extend Memoist
+    include Stack::Helper
+
+    def initialize(options)
+      @options = options
+      @cluster = @options[:cluster] || default_cluster
+    end
+
+    def list
+      begin
+        resp = ecs.list_services(cluster: @cluster)
+      rescue Aws::ECS::Errors::ClusterNotFoundException => e
+        puts "ECS cluster #{@cluster.colorize(:green)} not found."
+        exit 1
+      end
+      arns = resp.service_arns.sort
+
+      puts "Listing ECS services in the #{@cluster.colorize(:green)} cluster."
+      if arns.empty?
+        puts "No ECS services found in the #{@cluster.colorize(:green)} cluster."
+        return
+      end
+
+      resp = ecs.describe_services(services: arns, cluster: @cluster)
+      display_info(resp)
+    end
+
+    def display_info(resp)
+      table = Text::Table.new
+      table.head = ["Service Name", "Task Definition", "Running", "Launch type", "Ufo?"]
+      resp["services"].each do |s|
+        table.rows << service_info(s)
+      end
+      puts table unless ENV['TEST']
+    end
+
+    # for specs
+    def service_info(s)
+      Service.new(s, @options).to_a
+    end
+  end
+end

data/lib/ufo/apps/cfn_map.rb

@@ -0,0 +1,70 @@
+class Ufo::Apps
+  class CfnMap
+    extend Memoist
+    include Ufo::Stack::Helper
+
+    def initialize(options = {})
+      @options = options
+      @cluster = @options[:cluster] || default_cluster
+      @map = {}
+    end
+
+    # Example:
+    #   {"development-demo-web-Ecs-1L3WUTJFFM5JV"=>"demo-web"}
+    def map
+      return @map if @populated
+
+      populate_map!
+      @populated = true
+      @map
+    end
+
+    def summaries
+      filter = %w[
+        UPDATE_COMPLETE
+        CREATE_COMPLETE
+        UPDATE_ROLLBACK_COMPLETE
+        UPDATE_IN_PROGRESS
+        UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
+        UPDATE_ROLLBACK_IN_PROGRESS
+        UPDATE_ROLLBACK_FAILED
+        UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
+        REVIEW_IN_PROGRESS
+      ]
+
+      summaries = []
+      next_token = true
+      while next_token
+        resp = cloudformation.list_stacks(stack_status_filter: filter)
+        summaries += resp.stack_summaries
+        next_token = resp.next_token
+      end
+
+      # look for stacks that beling that ufo create
+      summaries.select do |s|
+        s.template_description =~ /Ufo ECS stack/
+      end
+    end
+    memoize :summaries
+
+    def populate_map!
+      threads = []
+      summaries.each do |summary|
+        threads << Thread.new do
+          resp = cloudformation.describe_stack_resources(stack_name: summary.stack_name)
+          ecs_resource = resp.stack_resources.find do |resource|
+            resource.logical_resource_id == "Ecs"
+          end
+          # Example: "PhysicalResourceId": "arn:aws:ecs:us-east-1:111111111111:service/dev-demo-web-Ecs-1HRL8Y9F4D1CR"
+          ecs_service_name = ecs_resource.physical_resource_id.split('/').last
+          @map[ecs_service_name] = stack_name_to_service_name(summary.stack_name)
+        end
+      end
+      threads.map(&:join)
+    end
+
+    def stack_name_to_service_name(stack_name)
+      stack_name.sub("#{@cluster}-",'')
+    end
+  end
+end