ufo 5.0.5 → 6.0.0

data/lib/ufo/cli/central/update.rb

@@ -0,0 +1,80 @@
+class Ufo::CLI::Central
+  class Update
+    include Ufo::Utils::Logging
+    include Ufo::Utils::Execute
+    include Ufo::Utils::Sure
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def run
+      action = File.exist?(".ufo") ? "update" : "create"
+      sure?("Will #{action} the .ufo folder.") # IE: Will create the .ufo folder.
+      validate!
+      logger.info "Updating .ufo with #{repo}"
+      FileUtils.mkdir_p(tmp_area)
+      pull
+      sync
+      check_gitignore
+    end
+
+    def pull
+      logger.debug "Within #{tmp_area}"
+      Dir.chdir(tmp_area) do
+        if File.exist?(repo_name)
+          execute "cd #{repo_name} && git pull"
+        else
+          execute "git clone #{repo}"
+        end
+      end
+    end
+
+    def sync
+      FileUtils.mv(".ufo", ".ufo.bak") if File.exist?(".ufo")
+      src = "#{tmp_area}/#{repo_name}"
+      src += "/#{folder}" if folder
+      FileUtils.cp_r(src, ".ufo")
+      FileUtils.rm_rf(".ufo.bak")
+      logger.info "The .ufo folder has been updated"
+    end
+
+    def validate!
+      return if repo
+      logger.info "ERROR: Please set the env var: UFO_CENTRAL_REPO".color(:red)
+      exit 1
+    end
+
+    def repo_name
+      File.basename(repo)
+    end
+
+    def repo
+      ENV['UFO_CENTRAL_REPO']
+    end
+
+    def folder
+      ENV['UFO_CENTRAL_FOLDER']
+    end
+
+    def tmp_area
+      "/tmp/ufo/central"
+    end
+
+    def check_gitignore
+      ok = true
+      if File.exist?('.gitignore')
+        lines = IO.readlines('.gitignore')
+        ok = lines.detect do |line|
+          line =~ %r{/?.ufo/?$}
+        end
+      end
+      return if ok
+      logger.info "No .ufo found in your .gitignore file".color(:yellow)
+      logger.info <<~EOL
+        It's recommended to add .ufo to the .gitignore
+        When using ufo in a central fashion
+      EOL
+    end
+  end
+end

data/lib/ufo/cli/central.rb

@@ -0,0 +1,12 @@
+class Ufo::CLI
+  class Central < Ufo::Command
+    opts = Opts.new(self)
+
+    desc "update", "update .ufo from central repo"
+    long_desc Help.text("central/update")
+    opts.yes
+    def update
+      Update.new(options).run
+    end
+  end
+end

data/lib/ufo/cli/clean.rb

@@ -0,0 +1,17 @@
+require "fileutils"
+
+class Ufo::CLI
+  class Clean < Base
+    def run
+      folders = %w[log output tmp]
+      folders = folders.map do |folder|
+        ".ufo/#{folder}"
+      end
+      sure?("Will remove folders: #{folders.join(' ')}")
+      folders.each do |folder|
+        FileUtils.rm_rf("#{Ufo.root}/#{folder}")
+      end
+      logger.info "Removed folders: #{folders.join(' ')}"
+    end
+  end
+end

data/lib/ufo/cli/destroy.rb

@@ -0,0 +1,31 @@
+class Ufo::CLI
+  class Destroy < Base
+    def run
+      are_you_sure?
+
+      stack = find_stack(@stack_name)
+      unless stack
+        puts "Stack #{@stack_name.color(:green)} does not exist."
+        exit 1
+      end
+
+      if stack.stack_status =~ /_IN_PROGRESS$/
+        puts "Cannot destroy service #{@service.color(:green)}"
+        puts "Cannot delete stack #{@stack_name.color(:green)} in this state: #{stack.stack_status.color(:green)}"
+        puts "If the stack is taking a long time, you can cancel the current operation with:"
+        puts "    ufo cancel #{@service}"
+        return
+      end
+
+      cloudformation.delete_stack(stack_name: @stack_name)
+      puts "Deleting stack with ECS resources: #{@stack_name}"
+
+      return unless @options[:wait]
+      status.wait
+    end
+
+    def are_you_sure?
+      sure?("You are about to destroy the #{@stack_name.color(:green)} stack")
+    end
+  end
+end

data/lib/ufo/{docker.rb → cli/docker.rb}

@@ -1,57 +1,57 @@
-module Ufo
-  class Docker < Command
+class Ufo::CLI
+  class Docker < Ufo::Command
     desc "build", "Build docker image."
-    long_desc Help.text("docker:build")
+    long_desc Help.text("docker/build")
     option :push, type: :boolean, default: false
     def build
-      builder = Docker::Builder.new(options)
+      builder = Ufo::Docker::Builder.new(options)
       builder.build
       push if options[:push]
     end
 
     desc "compile", "Compile Dockerfile.erb"
-    long_desc Help.text("docker:compile")
+    long_desc Help.text("docker/compile")
     def compile
-      builder = Docker::Builder.new(options)
+      builder = Ufo::Docker::Builder.new(options)
       builder.compile
     end
 
     desc "push IMAGE", "Push the docker image."
-    long_desc Help.text("docker:push")
+    long_desc Help.text("docker/push")
     option :push, type: :boolean, default: false
-    def push(full_image_name=nil)
-      # full_image_name of nil results in defaulting to the last built image by ufo docker build
-      pusher = Docker::Pusher.new(full_image_name, options)
+    def push(docker_image=nil)
+      # docker_image of nil results in defaulting to the last built image by ufo docker build
+      pusher = Ufo::Docker::Pusher.new(docker_image, options)
       pusher.push
     end
 
     desc "base", "Build docker image from `Dockerfile.base` and update current `Dockerfile`."
-    long_desc Help.text("docker:base")
+    long_desc Help.text("docker/base")
     option :push, type: :boolean, default: true
     def base
-      builder = Docker::Builder.new(options.dup.merge(
+      builder = Ufo::Docker::Builder.new(options.dup.merge(
         image_namespace: "base",
         dockerfile: "Dockerfile.base"
       ))
       builder.build
       builder.push if options[:push]
       builder.update_dockerfile
-      Docker::Cleaner.new(builder.image_name, options.merge(tag_prefix: "base")).cleanup
-      Ecr::Cleaner.new(builder.image_name, options.merge(tag_prefix: "base")).cleanup
+      Ufo::Docker::Cleaner.new(builder.image_name, options.merge(tag_prefix: "base")).cleanup
+      Ufo::Ecr::Cleaner.new(builder.image_name, options.merge(tag_prefix: "base")).cleanup
     end
 
     desc "name", "Display the full docker image with tag that was last generated."
     option :generate, type: :boolean, default: false, desc: "Generate a name without storing it"
-    long_desc Help.text("docker:name")
+    long_desc Help.text("docker/name")
     def name
-      full_image_name = Docker::Builder.new(options).full_image_name
-      puts full_image_name
+      docker_image = Ufo::Docker::Builder.new(options).docker_image
+      puts docker_image
     end
 
     desc "clean IMAGE_NAME", "Clean up old images.  Keeps a specified amount."
     option :keep, type: :numeric, default: 3
     option :tag_prefix, default: "ufo"
-    long_desc Help.text("docker:clean")
+    long_desc Help.text("docker/clean")
     def clean(image_name)
       Docker::Cleaner.new(image_name, options).cleanup
     end

data/lib/ufo/cli/exec.rb

@@ -0,0 +1,82 @@
+class Ufo::CLI
+  class Exec < Base
+    def run
+      check_install!
+      service = info.service
+      return unless service # brand new deploy
+
+      running = service_tasks.select do |task|
+        task.last_status == "RUNNING"
+      end
+      if running.empty?
+        logger.info "No running tasks found to exec into"
+        return
+      end
+
+      tasks = running.sort_by { |t| t.started_at }
+      task = tasks.last # most recent
+
+      task_name = task.task_arn.split('/').last
+      execute_command(
+        cluster: "#{@cluster}",
+        task: task_name,
+        container: container(task), # only required if multiple containers in a task
+        interactive: true,
+        command: command
+      )
+    end
+
+    def container(task)
+      return @options[:container] if @options[:container]
+      containers = task.containers
+      container = containers.find do |c|
+        c.name == @options[:role]
+      end
+      container ||= containers.first  # assume first task if not roles match
+      container.name if container
+    end
+
+    def execute_command(options={})
+      args = options.inject('') do |args, (k,v)|
+        arg = k == :interactive ? "--#{k}" : "--#{k} #{v}"
+        args += " #{arg}"
+      end
+      sh "aws ecs execute-command#{args}"
+    end
+
+    def service_tasks
+      service_name = info.service.service_name
+      all_task_arns = ecs.list_tasks(cluster: @cluster, service_name: service_name).task_arns
+      return [] if all_task_arns.empty?
+      ecs.describe_tasks(cluster: @cluster, tasks: all_task_arns).tasks
+    end
+
+    def sh(command)
+      puts "=> #{command}"
+      Kernel.exec command
+    end
+
+    def command
+      @options[:command] || Ufo.config.exec.command
+    end
+
+    def check_install!
+      check_session_manager_plugin!
+      check_aws_cli!
+    end
+
+    def check_session_manager_plugin!
+      installed = system "type session-manager-plugin > /dev/null 2>&1"
+      return if installed
+      logger.error "ERROR: The Session Manager plugin required to use ufo exec".color(:red)
+      exit 1
+    end
+
+    def check_aws_cli!
+      installed = system "type aws > /dev/null 2>&1"
+      return if installed
+      logger.error "ERROR: aws cli is required to use ufo exec".color(:red)
+      exit 1
+    end
+  end
+end

data/lib/ufo/cli/help/central/update.md

@@ -0,0 +1,20 @@
+The `UFO_CENTRAL_REPO` env var is required to use `ufo central update`.
+
+## Example
+
+    $ export UFO_CENTRAL_REPO=git@github.com:org/repo
+    $ ufo central update
+    Will create the .ufo folder.
+    Are you sure? (y/N) y
+    Updating .ufo with git@github.com:org/repo
+    => git clone git@github.com:org/repo
+    The .ufo folder has been updated
+    $
+
+## Subfolders
+
+If the ufo folder is within a subfolder.
+
+  export UFO_CENTRAL_FOLDER=subfolder
+
+This will copy over the subfolder within the repo.

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

@@ -0,0 +1,9 @@
+## Examples
+
+Deletes the CloudFormation stack and destroys the ECS Service resources.
+
+    ufo destroy
+
+If you would like to bypass the prompt, you can use the `-y` option.
+
+    ufo destroy -y

data/lib/ufo/cli/help/docker/base.md

@@ -0,0 +1,39 @@
+The docker cache task builds a docker image using the `Dockerfile.base` file and
+updates the FROM `Dockerfile` image with the generated image from `Dockerfile.base`.
+
+## Summarized Example
+
+    ufo docker base
+    ufo docker base --no-push # do not push the image to the registry
+
+Docker image `org/repo:base-2016-10-21T15-50-57-88071f5` built.
+
+## Detailed Example
+
+Let's see the command in action:
+
+    $ ufo docker base
+    Building docker image with:
+      docker build -t org/repo:base-2017-06-12T14-36-44-2af505e -f Dockerfile.base .
+      ...
+    Pushed org/repo:base-2017-06-12T14-36-44-2af505e docker image. Took 28s.
+    The Dockerfile FROM statement has been updated with the latest base image:
+      org/repo:base-2017-06-12T14-36-44-2af505e
+
+Some of the output has been excluded so we can focus on the essential parts to point out. First, notice that the command simply shells out to the docker command and calls:
+
+    docker build -t org/repo:base-2017-06-12T14-36-44-2af505e -f Dockerfile.base .
+
+It uses the docker `-f Dockerfile.base` option to build the base image.  It names the image with `org/repo:base-2017-06-12T14-36-44-2af505e`.  The image tag contains useful information: the timestamp and exact git sha of the code.  The image gets pushed to a registry immediately.
+
+## Dockerfile FROM updated
+
+Notice at the very end, the *current* `Dockerfile`'s FROM statement has been updated with the newly built base Docker image automatically.  This saves you from forgetting to copy and paste it the `Dockerfile` yourself.
+
+If you're using a [Dockerfile.erb](https://ufoships.com/docs/extras/dockerfile-erb/), then ufo will update the `.ufo/state/data.yml` file instead.  It assumes you're using a `Dockerfile.erb` that looks something like this:
+
+```Dockerfile
+FROM <%= @base_image %>
+# ...
+CMD ["bin/web"]
+```

data/lib/ufo/{help → cli/help}/docker/build.md

@@ -1,16 +1,16 @@
-The `ufo docker build` builds a Docker image using the Dockerfile in the current project folder.  This simply is a wrapper command that shells out and calls the `docker` command.  We're use the [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo) project and it's Dockerfile for demonstration.  Example:
+The `ufo docker build` builds a Docker image using the Dockerfile in the current project folder.  This simply is a wrapper command that shells out and calls the `docker` command.  We're use the [org/repo](https://github.com/org/repo) project and it's Dockerfile for demonstration.  Example:
 
     ufo docker build
 
 You'll see that it calls:
 
-    docker build -t tongueroo/demo-ufo:ufo-2017-06-11T22-18-03-a18aa30 -f Dockerfile .
+    docker build -t org/repo:ufo-2017-06-11T22-18-03-a18aa30 -f Dockerfile .
 
 You should see similar output (some of the output has been truncated for conciseness):
 
     $ ufo docker build
     Building docker image with:
-      docker build -t tongueroo/demo-ufo:ufo-2017-06-11T22-18-03-a18aa30 -f Dockerfile .
+      docker build -t org/repo:ufo-2017-06-11T22-18-03-a18aa30 -f Dockerfile .
     Sending build context to Docker daemon 734.2 kB
     Step 1 : FROM ruby:2.3.3
      ---> 0e1db669d557
@@ -37,7 +37,7 @@ You should see similar output (some of the output has been truncated for concise
      ---> 8547bb48b21f
     Removing intermediate container b1b26e68d957
     Successfully built 8547bb48b21f
-    Docker image tongueroo/demo-ufo:ufo-2017-06-11T22-18-03-a18aa30 built.  Took 33s.
+    Docker image org/repo:ufo-2017-06-11T22-18-03-a18aa30 built.  Took 33s.
     $
 
 The docker image tag that is generated contains a useful timestamp and the current HEAD git sha of the project that you are on.
@@ -48,14 +48,14 @@ By default when you are running `ufo docker build` directly it does not push the
 
 You should see it being pushed at the end:
 
-    Docker image tongueroo/demo-ufo:ufo-2017-06-11T22-22-32-a18aa30 built.  Took 34s.
-    The push refers to a repository [docker.io/tongueroo/demo-ufo]
+    Docker image org/repo:ufo-2017-06-11T22-22-32-a18aa30 built.  Took 34s.
+    The push refers to a repository [docker.io/org/repo]
     ef375857f165: Pushed
     4d791d7cde66: Pushed
     277ff31e79b4: Layer already exists
     a361a4de05df: Layer already exists
     ufo-2017-06-11T22-22-32-a18aa30: digest: sha256:c5385a5084e87643bd943eb120e110321c59e8acd30736ba7b5223eb1143baa8 size: 3464
-    Pushed tongueroo/demo-ufo:ufo-2017-06-11T22-22-32-a18aa30 docker image. Took 9s.
+    Pushed org/repo:ufo-2017-06-11T22-22-32-a18aa30 docker image. Took 9s.
 
 Note in order to push the image to a registry you will need to login into the registry.  If you are using DockerHub use the `docker login` command.  If you are using AWS ECR then you can use the `aws ecr get-login` command.
 
@@ -65,6 +65,6 @@ You can specify docker build options with the `UFO_DOCKER_BUILD_OPTIONS` environ
 
     $ UFO_DOCKER_BUILD_OPTIONS="--build-arg RAILS_ENV=production" ufo docker build
     Building docker image with:
-      docker build --build-arg RAILS_ENV=production -t tongueroo/demo-ufo:ufo-2018-05-19T11-52-16-6714713 -f Dockerfile .
+      docker build --build-arg RAILS_ENV=production -t org/repo:ufo-2018-05-19T11-52-16-6714713 -f Dockerfile .
     ...
-    Docker image tongueroo/demo-ufo:ufo-2018-05-19T11-52-16-6714713 built.  Took 2s.
+    Docker image org/repo:ufo-2018-05-19T11-52-16-6714713 built.  Took 2s.

data/lib/ufo/{help → cli/help}/docker/clean.md

@@ -2,19 +2,19 @@ Ufo comes with a handy command to clean up old images that ufo generates. Ufo on
 
 Say you currently have these images:
 
-    tongueroo/demo-ufo:ufo-2016-10-15T19-29-06-88071f5
-    tongueroo/demo-ufo:ufo-2016-10-16T19-29-06-88071f5
-    tongueroo/demo-ufo:ufo-2016-10-17T19-29-06-88071f5
-    tongueroo/demo-ufo:ufo-2016-10-18T19-29-06-88071f5
+    org/repo:ufo-2016-10-15T19-29-06-88071f5
+    org/repo:ufo-2016-10-16T19-29-06-88071f5
+    org/repo:ufo-2016-10-17T19-29-06-88071f5
+    org/repo:ufo-2016-10-18T19-29-06-88071f5
 
 To clean them up and keep the 3 more recent:
 
-    $ ufo docker clean tongueroo/demo-ufo
+    $ ufo docker clean org/repo
     Cleaning up docker images...
-    Running: docker rmi tongueroo/demo-ufo:ufo-2016-10-15T19-29-06-88071f5
+    Running: docker rmi org/repo:ufo-2016-10-15T19-29-06-88071f5
 
-This will remove tongueroo/demo-ufo:ufo-2016-10-15T19-29-06-88071f5.
+This will remove org/repo:ufo-2016-10-15T19-29-06-88071f5.
 
 By default the clean command keeps the most 3 recent docker images. If you would like to override this setting you can use the `--keep` option. Example:
 
-    ufo docker clean tongueroo/demo-ufo --keep 5
+    ufo docker clean org/repo --keep 5

data/lib/ufo/cli/help/docker/name.md

@@ -0,0 +1,16 @@
+It is sometimes handy to grab the name of the Docker image that was just generated.  Let's say ou needed the image name so you can feed it into another script that you have. The command `ufo docker name` returns the image of the most recently built Docker image.
+
+## Examples
+
+    ufo docker build # stores the docker image name in the .ufo/tmp/state folder
+    ufo docker name  # fetches image name from .ufo/tmp/state folder
+
+An example image name would look something like this: `org/repo:ufo-2018-02-15T19-29-06-88071f5`
+
+Note, the `.ufo/tmp/state` folder is an internal data folder and it's structure can change in future releases.
+
+If you want to generate a brand new name for whatever purpose, you can use the `--generate` flag.  The generate does not write to the `.ufo/tmp/state` folder.  It only generates a fresh name to stdout.  If you run it multiple times, it will generate new names.  You can notice this by seeing that the timestamp will always update:
+
+    ufo docker name --generate  # example: org/repo:ufo-2018-02-15T10-00-00-88071f5
+    ufo docker name --generate  # example: org/repo:ufo-2018-02-15T10-00-08-88071f5
+    ufo docker name --generate  # example: org/repo:ufo-2018-02-15T10-00-16-88071f5

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

@@ -0,0 +1,6 @@
+## Examples
+
+    ufo docker base
+    ufo docker build
+    ufo docker name
+    ufo docker push

data/lib/ufo/{help → cli/help}/help.md

@@ -2,4 +2,4 @@ Displays process information about the service.
 
 ## Examples
 
-    $ ufo ps demo-web
+    ufo ps

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

@@ -0,0 +1,27 @@
+The `ufo init` command setup a project to be ufo ready. It creates a `.ufo` folder with a starter structure.
+
+The command requires the `--image` option.  If the `--app` option is not provided, then it is inferred and set as the parent folder name. Example:
+
+    cd demo
+    ufo init --app demo --image org/repo
+    ufo init --image org/repo # same as --app demo
+
+## Examples
+
+    $ mkdir demo
+    $ cd demo
+    $ ufo init --app demo --image org/repo
+    Generating .ufo structure
+          create  .ufo/config.rb
+          create  .ufo/config/web/base.rb
+          create  .ufo/config/web/dev.rb
+          create  .ufo/config/web/prod.rb
+          create  .ufo/resources/iam_roles/execution_role.rb
+          create  .ufo/resources/iam_roles/task_role.rb
+          create  .ufo/resources/task_definitions/web.yml
+          create  .ufo/vars/base.rb
+          create  .ufo/vars/dev.rb
+          create  .ufo/vars/prod.rb
+          create  .gitignore
+          create  .dockerignore
+          create  Dockerfile

data/lib/ufo/{help → cli/help}/logs.md

@@ -1,10 +1,11 @@
 ## Examples
 
-    ufo logs demo-web
+    ufo logs
 
-If you have a current service name set.
-
-    ufo current --service demo-web
     ufo logs # follow by default
     ufo logs --no-follow
     ufo logs --format detailed # to show stream too
+
+Filter HealthChecker
+
+    ufo logs --filter-pattern '- "HealthChecker"'

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

@@ -0,0 +1,12 @@
+## Examples
+
+    $ ufo ps
+    Stack: demo-web-dev
+    Service: demo-web-dev-EcsService-6Tb9EQqC23HA
+    Tasks: Running: 1 Desired: 1 Min: 1 Max: 2
+    Application ELB: demo-we-Elb-7DSB8ODFY8QP-1678773019.us-west-2.elb.amazonaws.com
+    +----------------------------------+------+-----------------+----------------+---------+
+    |               Task               | Name |     Release     |    Started     | Status  |
+    +----------------------------------+------+-----------------+----------------+---------+
+    | 3ea2ec8300ef49ab8d0071568525eb33 | web  | demo-web-dev:55 | 26 seconds ago | RUNNING |
+    +----------------------------------+------+-----------------+----------------+---------+

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

@@ -0,0 +1,15 @@
+## Example
+
+    $ ufo releases
+    Latest task definitions for stack: demo-web-dev
+        demo-web-dev:55
+        demo-web-dev:54
+        demo-web-dev:53
+        demo-web-dev:52
+        demo-web-dev:51
+        demo-web-dev:50
+        demo-web-dev:49
+        demo-web-dev:48
+        demo-web-dev:47
+        demo-web-dev:46
+        demo-web-dev:45

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

@@ -0,0 +1,40 @@
+## Examples
+
+You only need to specific the task definition version number, though you can specify the name also
+
+    $ ufo rollback 54
+    Will rollback to task definition version: 54
+    Are you sure? (y/N) y
+    Rolling back ECS service to task definition demo-web-dev:54
+    Will deploy stack demo-web-dev
+    Parameters built:      .ufo/output/params.json
+    Template built:        .ufo/output/template.yml
+    Updating stack demo-web-dev
+    Waiting for stack to complete
+    06:17:01PM UPDATE_IN_PROGRESS AWS::CloudFormation::Stack demo-web-dev User Initiated
+    06:17:08PM UPDATE_IN_PROGRESS AWS::ECS::Service EcsService
+    ..
+
+To see recent task definitions:
+
+    ufo releases
+
+Note, task definitions get created by many ways with more than just `ufo ship`. So it the previous version might not be the latest version number minus one.
+
+## Using image name
+
+Another way to specify the version for rollback is with the container definition's image value.  Here's the portion of the ecs task definition that you would look for:
+
+    ...
+    "container_definitions": [
+      {
+        "name": "web",
+        "image": "org/repo:ufo-2018-06-21T15-03-52-ac60240",
+        "cpu": 256,
+    ...
+
+You need to specify enough for a match to be found.  Ufo searches the 30 most recent task definitions. So all of these would work:
+
+    ufo rollback org/repo:ufo-2018-06-21T15-03-52-ac60240
+    ufo rollback 2018-06-21T15-03-52
+    ufo rollback ac60240

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

@@ -0,0 +1,7 @@
+Ufo provides a command to scale up and down an ECS service quickly. However, the scaling configuration is only a temporary update until the next `ufo ship`.
+
+    ufo scale --desired 2
+
+If you've configured ECS Service AutoScaling with ufo then you can also update the Scaling configuration.
+
+    ufo scale --min 1 --max 2