ufo 5.0.7 → 6.0.0

data/lib/ufo/help/tasks/build.md

@@ -1,158 +0,0 @@
-## Summarized Example
-
-    ufo tasks build
-
-Builds all the task defintiions. Note all the existing ufo/output generated task defintions are wiped out.
-
-## Explanation
-
-The command `ufo tasks build` generates the task definitions locally and writes them to the `output/` folder.  There are 2 files that it uses in order to produce the raw AWS task definitions files.
-
-1. ufo/templates/main.json.erb
-2. ufo/task_definitions.rb
-
-Here's an example of each of them:
-
-**main.json.erb**:
-
-    {
-        "family": "<%= @family %>",
-        "containerDefinitions": [
-            {
-                "name": "<%= @name %>",
-                "image": "<%= @image %>",
-                "cpu": <%= @cpu %>,
-                <% if @memory %>
-                "memory": <%= @memory %>,
-                <% end %>
-                <% if @memory_reservation %>
-                "memoryReservation": <%= @memory_reservation %>,
-                <% end %>
-                <% if @container_port %>
-                "portMappings": [
-                    {
-                        "containerPort": "<%= @container_port %>",
-                        "protocol": "tcp"
-                    }
-                ],
-                <% end %>
-                "command": <%= @command.to_json %>,
-                <% if @environment %>
-                "environment": <%= @environment.to_json %>,
-                <% end %>
-                <% if @awslogs_group %>
-                "logConfiguration": {
-                    "logDriver": "awslogs",
-                    "options": {
-                        "awslogs-group": "<%= @awslogs_group %>",
-                        "awslogs-region": "<%= @awslogs_region || 'us-east-1' %>",
-                        "awslogs-stream-prefix": "<%= @awslogs_stream_prefix %>"
-                    }
-                },
-                <% end %>
-                "essential": true
-            }
-        ]
-    }
-
-**task_definitions.rb**:
-
-```ruby
-task_definition "demo-web" do
-  source "main" # will use ufo/templates/main.json.erb
-  variables(
-    family: task_definition_name,
-    name: "web",
-    container_port: helper.dockerfile_port,
-    command: ["bin/web"]
-  )
-end
-
-task_definition "demo-worker" do
-  source "main" # will use ufo/templates/main.json.erb
-  variables(
-    family: task_definition_name,
-    name: "worker",
-    command: ["bin/worker"]
-  )
-end
-
-task_definition "demo-clock" do
-  source "main" # will use ufo/templates/main.json.erb
-  variables(
-    family: task_definition_name,
-    name: "clock",
-    command: ["bin/clock"]
-  )
-end
-```
-
-The shared variables are set in the variables folder:
-
-**ufo/variables/base.rb**:
-
-```ruby
-@image = helper.full_image_name # includes the git sha tongueroo/demo-ufo:ufo-[sha].
-@cpu = 128
-@memory_reservation = 256
-@environment = helper.env_file(".env")
-```
-
-**ufo/variables/production.rb**:
-
-```ruby
-@environment = helper.env_vars(%Q{
-  RAILS_ENV=production
-  SECRET_KEY_BASE=secret
-})
-```
-
-Ufo combines the `main.json.erb` template, `task_definitions.rb` definitions, and variables in the `.ufo/variables` folder.  It then generates the raw AWS formatted task definition in the `output` folder.
-
-To build the task definitions:
-
-    ufo tasks build
-
-You should see output similar to below:
-
-    $ ufo tasks build
-    Building Task Definitions...
-    Generating Task Definitions:
-      ufo/output/demo-web.json
-      ufo/output/demo-worker.json
-      ufo/output/demo-clock.json
-    Task Definitions built in ufo/output.
-    $
-
-Let's take a look at one of the generated files: `.ufo/output/demo-web.json`.
-
-    {
-      "family": "demo-web",
-      "containerDefinitions": [
-        {
-          "name": "web",
-          "image": "tongueroo/demo-ufo:ufo-2017-06-11T22-22-32-a18aa30",
-          "cpu": 128,
-          "memoryReservation": 256,
-          "portMappings": [
-            {
-              "containerPort": "3000",
-              "protocol": "tcp"
-            }
-          ],
-          "command": [
-            "bin/web"
-          ],
-          "environment": [
-            {
-              "name": "RAILS_ENV",
-              "value": "staging"
-            }
-          ],
-          "essential": true
-        }
-      ]
-    }
-
-If you need to modify the task definition template to suite your own needs it is super simple, just edit `main.json.erb`.  No need to dive deep into internal code that builds up the task definition with some internal structure.  It is all there for you to fully control.
-

data/lib/ufo/help/tasks/register.md

@@ -1,14 +0,0 @@
-The `ufo tasks register` command registers all the generated task definitions in `output/` to AWS ECS. Let's run it:
-
-    ufo tasks register
-
-You should see something similiar to this:
-
-    demo-clock task definition registered.
-    demo-web task definition registered.
-    demo-worker task definition registered.
-
-You can verify that the task definitions have been registered properly by viewing the AWS ECS Console Task Definitions page.  You should see something similar to this:
-
-<img src="/img/tutorials/ecs-console-task-definitions.png" class="doc-photo" />
-

data/lib/ufo/help/tasks.md

@@ -1,7 +0,0 @@
-## Examples
-
-  ufo tasks build
-
-Builds all the task defintiions.
-
-Note all the existing ufo/output generated task defintions are wiped out.

data/lib/ufo/help/upgrade/v3to4.md

@@ -1,3 +0,0 @@
-## Examples
-
-    ufo upgrade v3to4 --vpc-id vpc-123 --ecs-subnets subnet-111 subnet-222 --elb-subnets subnet-111 subnet-222

data/lib/ufo/help.rb

@@ -1,9 +0,0 @@
-module Ufo::Help
-  class << self
-    def text(namespaced_command)
-      path = namespaced_command.to_s.gsub(':','/')
-      path = File.expand_path("../help/#{path}.md", __FILE__)
-      IO.read(path) if File.exist?(path)
-    end
-  end
-end

data/lib/ufo/init.rb

@@ -1,119 +0,0 @@
-module Ufo
-  class Init < Sequence
-    include Network::Helper
-
-    # Ugly, this is how I can get the options from to match with this Thor::Group
-    def self.cli_options
-      [
-        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
-        [:image, required: true, desc: "Docker image name without the tag. Example: tongueroo/demo-ufo. Configures ufo/settings.yml"],
-        [:app, desc: "App name. Preferably one word. Used in the generated ufo/task_definitions.rb.  If not specified then the app name is inferred as the folder name."],
-        [:launch_type, default: "ec2", desc: "ec2 or fargate."],
-        [:template, desc: "Custom template to use."],
-        [:template_mode, desc: "Template mode: replace or additive."],
-        [:vpc_id, desc: "Vpc id. For settings/network/default.yml."],
-        [:ecs_subnets, type: :array, desc: "Subnets for ECS tasks, defaults to --elb-subnets set to. For settings/network/default.yml"],
-        [:elb_subnets, type: :array, desc: "Subnets for ELB. For settings/network/default.yml"],
-      ]
-    end
-    cli_options.each { |o| class_option(*o) }
-
-    def setup_template_repo
-      return unless @options[:template]&.include?('/')
-
-      sync_template_repo
-    end
-
-    def set_source_path
-      return unless @options[:template]
-
-      custom_template = "#{ENV['HOME']}/.ufo/templates/#{@options[:template]}"
-
-      if @options[:template_mode] == "replace" # replace the template entirely
-        override_source_paths(custom_template)
-      else # additive: modify on top of default template
-        default_template = File.expand_path("../../template", __FILE__)
-        override_source_paths([custom_template, default_template])
-      end
-    end
-
-    # for specs
-    def set_destination_root
-      return unless ENV['UFO_ROOT']
-
-      dest = ENV['UFO_ROOT']
-      FileUtils.rm_rf(dest) && FileUtils.mkdir_p(dest)
-      self.destination_root = dest
-      FileUtils.cd(dest)
-    end
-
-    def set_network_options
-      configure_network_settings
-    end
-
-    def init_files
-      # map variables
-      @app = options[:app] || inferred_app
-      @image = options[:image]
-      # copy the files
-      puts "Setting up ufo project..."
-      exclude_pattern = File.exist?("#{Ufo.root}/Dockerfile") ?
-                          /(\.git|Dockerfile)/ :
-                          /(\.git)/
-      directory ".", exclude_pattern: exclude_pattern
-    end
-
-    def upsert_gitignore
-      text =<<-EOL
-.ufo/current
-.ufo/data
-.ufo/log
-.ufo/output
-EOL
-      if File.exist?(".gitignore")
-        append_to_file ".gitignore", text
-      else
-        create_file ".gitignore", text
-      end
-    end
-
-    def upsert_dockerignore
-      text = ".ufo\n"
-      if File.exist?(".dockerignore")
-        append_to_file ".dockerignore", text
-      else
-        create_file ".dockerignore", text
-      end
-    end
-
-    def user_message
-      puts "Starter ufo files created."
-      puts <<-EOL
-Congrats 🎉 You have successfully set up ufo for your project.
-#{"="*64}
-
-## Task Definition Customizations
-
-If you need to customize the ECS task definition to configure things like memory and cpu allocation. You can do this by adjusting the files the .ufo/variables folder. These variables get applied to the .ufo/templates/main.json.erb task definition json that is passed to the ECS register task definition api.
-
-Some additional starter example roles for your apps were set up in in .ufo/task_definitions.rb.  Be sure to check it out and adjust it for your needs.
-
-## Settings files
-
-Additionally, ufo generated starter settings files that allow you to customize more settings.
-
-* .ufo/settings.yml: general settings.
-* .ufo/settings/cfn/default.yml: properties of CloudFormation resources that ufo creates.
-* .ufo/settings/network/default.yml: network settings.
-
-More more info refer to: http://ufoships.com/docs/settings/
-
-To deploy to ECS:
-
-  ufo current --service #{@app}-web
-  ufo ship
-
-EOL
-    end
-  end
-end

data/lib/ufo/network/fetch.rb

@@ -1,48 +0,0 @@
-# Provides access to default network settings for a vpc: subnets and security_group
-# If no @vpc_id is provided to the initializer then the default vpc is used.
-class Ufo::Network
-  class Fetch
-    include Ufo::AwsService
-    extend Memoist
-
-    def initialize(vpc_id)
-      @vpc_id = vpc_id
-    end
-
-    def vpc_id
-      return @vpc_id if @vpc_id
-
-      resp = ec2.describe_vpcs(filters: [
-        {name: "isDefault", values: ["true"]}
-      ])
-      default_vpc = resp.vpcs.first
-      if default_vpc
-        default_vpc.vpc_id
-      else
-        puts "A default vpc was not found in this AWS account and region.".color(:red)
-        puts "Because there is no default vpc, please specify the --vpc-id option.  More info: http://ufoships.com/reference/ufo-init/"
-        exit 1
-      end
-    end
-    memoize :vpc_id
-
-    # all subnets
-    def subnet_ids
-      resp = ec2.describe_subnets(filters: [
-        {name: "vpc-id", values: [vpc_id]}
-      ])
-      resp.subnets.map(&:subnet_id).sort
-    end
-    memoize :subnet_ids
-
-    # default security group
-    def security_group_id
-      resp = ec2.describe_security_groups(filters: [
-        {name: "vpc-id", values: [vpc_id]},
-        {name: "group-name", values: ["default"]}
-      ])
-      resp.security_groups.first.group_id
-    end
-    memoize :security_group_id
-  end
-end

data/lib/ufo/network/helper.rb

@@ -1,23 +0,0 @@
-class Ufo::Network
-  module Helper
-    private
-    # for balancer default profile
-    def configure_network_settings
-      @options = @options.dup
-      return test_network_settings if ENV['TEST']
-
-      fetch = Fetch.new(@options[:vpc_id])
-      @options[:vpc_id] ||= fetch.vpc_id
-      @options[:ecs_subnets] ||= fetch.subnet_ids
-      @options[:elb_subnets] ||= @options[:ecs_subnets] || fetch.subnet_ids
-    end
-
-    # hack for specs
-    def test_network_settings
-      @options[:vpc_id] = "vpc-111"
-      @options[:ecs_subnets] = ["subnet-111", "subnet-222"]
-      @options[:elb_subnets] = ["subnet-111", "subnet-222"]
-      @options
-    end
-  end
-end

data/lib/ufo/network/init.rb

@@ -1,26 +0,0 @@
-module Ufo
-  class Network::Init < Thor::Group
-    include Thor::Actions
-    include Network::Helper
-
-    add_runtime_options! # force, pretend, quiet, skip options
-      # https://github.com/erikhuda/thor/blob/master/lib/thor/actions.rb#L49
-
-    # Interesting, when defining the options in this class it screws up the ufo balance -h menu
-    Network.cli_options.each do |o|
-      class_option *o
-    end
-    def self.source_paths
-      [File.expand_path("../../../template/.ufo/settings/network", __FILE__)]
-    end
-
-    def set_network_options
-      configure_network_settings
-    end
-
-    def starter_files
-      filename = @options[:filename] || "default"
-      template "default.yml", ".ufo/settings/network/#{filename}.yml"
-    end
-  end
-end

data/lib/ufo/network.rb

@@ -1,21 +0,0 @@
-module Ufo
-  class Network < Command
-    def self.cli_options
-      [
-        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
-        [:ecs_subnets, type: :array, desc: "ECS Subnets"],
-        [:elb_subnets, type: :array, desc: "ELB Subnets"],
-        [:vpc_id, desc: "Vpc id"],
-        [:filename, default: "default", desc: "Name of the settings file to create w/o extension."],
-      ]
-    end
-
-    cli_options.each { |o| option(*o) }
-
-    desc "init", "Creates network starter settings file."
-    long_desc Help.text("network:init")
-    def init
-      Init.start
-    end
-  end
-end

data/lib/ufo/ps.rb

@@ -1,129 +0,0 @@
-require 'text-table'
-
-module Ufo
-  class Ps < Base
-    delegate :service, to: :info
-
-    def run
-      unless service
-        puts no_service_message
-        return
-      end
-
-      summary
-
-      if task_arns.empty?
-        puts "There are 0 running tasks."
-        return
-      end
-
-      all_task_arns = task_arns.each_slice(100).map do |arns|
-        resp = ecs.describe_tasks(tasks: arns, cluster: @cluster)
-        resp["tasks"]
-      end.flatten
-
-      display_tasks(all_task_arns)
-      display_scale_help
-      display_target_group_help
-    end
-
-    def summary
-      return unless @options[:summary]
-      puts "=> Service: #{full_service}"
-      puts "   Service name: #{service.service_name}"
-      puts "   Status: #{service.status}"
-      puts "   Running count: #{service.running_count}"
-      puts "   Desired count: #{service.desired_count}"
-      puts "   Launch type: #{service.launch_type}"
-      puts "   Task definition: #{service.task_definition.split('/').last}"
-      elb = info.load_balancer(service)
-      if elb
-        puts "   Elb: #{elb.dns_name}"
-        puts "   Elb type: #{elb.type}"
-      end
-      puts "   Route53: #{info.route53_dns}" if info.route53_dns
-    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
-
-      puts "There are targets in the target group reporting unhealthy.  This can cause containers to cycle. Here's the error:"
-      puts error_event.message.color(:red)
-      puts "Check out the ECS console events tab for more info."
-    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
-
-      puts "There is an issue scaling the #{@service.color(:green)} service to #{service.desired_count}.  Here's the error:"
-      puts error_event.message.color(: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_tasks(tasks)
-      table = Text::Table.new
-      Task.extra_columns = @options[:extra]
-      table.head = Task.header
-      tasks = tasks.sort_by { |t| t["task_arn"] }
-      tasks.each do |t|
-        task = Task.new(t)
-        table.rows << task.to_a unless task.hide?
-      end
-      puts table
-    end
-
-    def statuses
-      status = @options[:status].upcase
-      valid_statuses = %w[RUNNING PENDING STOPPED]
-      all_statuses = valid_statuses + ["ALL"]
-      unless all_statuses.include?(status)
-        puts "Invalid status filter provided. Please provided one of the following:"
-        puts all_statuses.map(&:downcase).join(", ")
-        exit 1
-      end
-
-      status == "ALL" ? valid_statuses : [status]
-    end
-
-    def task_arns
-      threads, results = [], {}
-      statuses.each do |status|
-        threads << Thread.new do
-          options = {
-            service_name: service.service_name,
-            cluster: @cluster,
-            desired_status: status,
-          }
-          # Limit display of too many stopped tasks
-          options[:max_results] = 20 if status == "STOPPED"
-          resp = ecs.list_tasks(options)
-          results[status] = resp.task_arns
-        end
-      end
-      threads.map(&:join)
-      results.values.flatten.uniq
-    end
-    memoize :task_arns
-  end
-end

data/lib/ufo/scale.rb

@@ -1,28 +0,0 @@
-module Ufo
-  class Scale < Base
-    delegate :service, to: :info
-
-    def initialize(service, count, options={})
-      super(service, options)
-      @count = count
-    end
-
-    def update
-      unless service_exists?
-        puts "Unable to find the #{@service.color(:green)} service on the #{@cluster.color(:green)} cluster."
-        puts "Are you sure you are trying to scale the right service on the right cluster?"
-        exit
-      end
-      ecs.update_service(
-        service: service.service_name,
-        cluster: @cluster,
-        desired_count: @count
-      )
-      puts "Scale #{full_service.color(:green)} service in #{@cluster.color(:green)} to #{@count}" unless @options[:mute]
-    end
-
-    def service_exists?
-      !!service
-    end
-  end
-end

data/lib/ufo/setting/profile.rb

@@ -1,44 +0,0 @@
-class Ufo::Setting
-  class Profile
-    extend Memoist
-
-    def initialize(type, profile=nil)
-      @type = type.to_s # cfn or network
-      @profile = profile
-    end
-
-    def data
-      names = [
-        @profile, # user specified
-        Ufo.env, # conventional based on env
-        "default", # fallback to default
-        "base", # finally fallback to base
-      ].compact.uniq
-      paths = names.map { |name| "#{Ufo.root}/.ufo/settings/#{@type}/#{name}.yml" }
-      found = paths.find { |p| File.exist?(p) }
-      unless found
-        puts "#{@type.camelize} profile not found. Please double check that it exists. Checked paths: #{paths}"
-        exit 1
-      end
-
-      text = RenderMePretty.result(found)
-      specific_data = yaml_load(text)
-
-      base = "#{Ufo.root}/.ufo/settings/#{@type}/base.yml"
-      base_data = if File.exist?(base)
-                    text = RenderMePretty.result(base)
-                    yaml_load(text)
-                  else
-                    {}
-                  end
-
-      base_data.deep_merge(specific_data)
-    end
-    memoize :data
-
-    def yaml_load(text)
-      result = YAML.load(text) # yaml file can contain nothing but comments
-      result.is_a?(Hash) ? result.deep_symbolize_keys : {}
-    end
-  end
-end

data/lib/ufo/setting/security_groups.rb

@@ -1,22 +0,0 @@
-class Ufo::Setting
-  class SecurityGroups
-    include Ufo::Settings
-    extend Memoist
-
-    def initialize(service, type)
-      @service, @type = service, type
-    end
-
-    def load
-      groups = network[@type] # IE: network[:ecs_security_groups] or network[:elb_security_groups]
-      return [] unless groups
-
-      case groups
-      when Array # same security groups used for all services
-        groups
-      when Hash # service specific security groups
-        groups[@service.to_sym] || []
-      end
-    end
-  end
-end