ufo 2.3.0 → 3.0.0

data/docs/_docs/ufo-init.md

@@ -16,7 +16,20 @@ ufo init --app=hi --image=tongueroo/hi
 
 You should see output similiar to this:
 
-<img src="/img/tutorials/ufo-init.png" class="doc-photo" />
+```sh
+$ ufo init --app=hi --image=tongueroo/hi
+Setting up ufo project...
+      create  .ufo/settings.yml
+      create  .ufo/task_definitions.rb
+      create  .ufo/templates/main.json.erb
+      create  .ufo/variables/base.rb
+      create  .ufo/variables/development.rb
+      create  .ufo/variables/production.rb
+      create  Dockerfile
+      create  bin/deploy
+      append  .gitignore
+Starter ufo files created.
+```
 
 The standard directory structure of the ufo folder looks like this:
 

data/docs/_docs/ufo-scale.md

@@ -5,7 +5,7 @@ title: ufo scale
 Ufo provides a command to quickly scale up and down an ECS service. Here's an example of how you use it:
 
 ```sh
-ufo scale hi-web
+ufo scale hi-web 3
 ```
 
 You should get output similiar to below:
@@ -16,8 +16,6 @@ Scale hi-web service in stag cluster to 3
 
 While scaling via this method is quick and convenient the [ECS Service AutoScaling](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html) that is built into ECS is a much more powerful way to manage scaling your ECS service.
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-ships.md %}">Back</a>
+<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-deploy.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/ufo-destroy.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-
-

data/docs/_docs/ufo-ships.md

@@ -40,13 +40,13 @@ ufo ships hi-web-1:my-task hi-clock-1:another-task hi-worker-1:third-task
 
 ### ufo ships Options
 
-The `ufo ships` and `ufo ship` command support the same options. The options are presented here again for convenience:
+The `ufo ships`, `ufo ship`, `ufo deploy` command support the same options. The options are presented here again for convenience:
 
 {% include ufo-ship-options.md %}
 
 Note: The `--task` option is not used with the `ufo ships` command.
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/ufo-ship.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-scale.md %}">Next Step</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/ufo-deploy.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
 

data/docs/_docs/variables.md

@@ -4,7 +4,7 @@ title: Shared Variables
 
 Often times, you end up using the set of common variables across your task definitions for a project.  Ufo supports a shared variables concept to help with this.  You specify variables files in the `ufo/variables` folder and they are made availale to your `ufo/task_definitions.rb` as well as your `ufo/templates` files.
 
-For example, given `config/variables/base.rb`:
+For example, given `variables/base.rb`:
 
 ```
 @image = helper.full_image_name # includes the git sha tongueroo/hi:ufo-[sha].
@@ -17,7 +17,7 @@ You can now use @image in your `ufo/templates/main.json.erb` without having to e
 
 ### Layering
 
-Shared variables also support a concept called layering.  The `config/variables/base.rb` file is treated specially and will always be evaluated.  Additionally, ufo will also evaluate the `config/variables/[UFO_ENV].rb` according to what UFO_ENV's value is. Thanks layering, you can easily override variables to suite different environments like production or staging. For example:
+Shared variables also support a concept called layering.  The `variables/base.rb` file is treated specially and will always be evaluated.  Additionally, ufo will also evaluate the `variables/[UFO_ENV].rb` according to what UFO_ENV's value is. Thanks to layering, you can easily override variables to suit different environments like `production` or `development`. For example:
 
 `ufo/variables/base.rb`:
 
@@ -28,7 +28,7 @@ Shared variables also support a concept called layering.  The `config/variables/
 @environment = helper.env_file(".env")
 ```
 
-When `ufo ship` is ran with `UFO_ENV=production` he `config/variables/production.rb` will be evaluated and layered on top of the variables defined in `base.rb:
+When `ufo ship` is ran with `UFO_ENV=production` he `variables/production.rb` will be evaluated and layered on top of the variables defined in `base.rb:
 
 `ufo/variables/production.rb`:
 
@@ -39,14 +39,14 @@ When `ufo ship` is ran with `UFO_ENV=production` he `config/variables/production
 ])
 ```
 
-When `ufo ship` is ran with `UFO_ENV=staging` he `config/variables/staging.rb` will be evaluated and layered on top of the variables defined in `base.rb:
+When `ufo ship` is ran with `UFO_ENV=development` the `variables/development.rb` will be evaluated and layered on top of the variables defined in `base.rb:
 
 
-`ufo/variables/production.rb`:
+`ufo/variables/development.rb`:
 
 ```ruby
 @environment = helper.env_vars(%Q[
-  RAILS_ENV=staging
+  RAILS_ENV=development
   SECRET_KEY_BASE=secret
 ])
 ```

data/docs/_includes/commands.html

@@ -19,7 +19,7 @@ ufo destroy
                     </div>
                 </div>
                 <div class="col-lg-6">
-                    <h3>ufo/variables/base.rb</h3>
+                    <h3>variables/base.rb</h3>
                     <div class="commands">
 {% highlight ruby %}
 @image = helper.full_image_name # includes the git sha tongueroo/hi:ufo-[sha].
@@ -35,7 +35,7 @@ ufo destroy
             </div>
             <div class="row">
                 <div class="col-lg-6">
-                    <h3>ufo/templates/main.json.erb</h3>
+                    <h3>templates/main.json.erb</h3>
                     <div class="commands">
 {% highlight json %}
 {
@@ -59,7 +59,7 @@ ufo destroy
                     </div>
                 </div>
                 <div class="col-lg-6">
-                    <h3>ufo/template_definitions.rb</h3>
+                    <h3>template_definitions.rb</h3>
                     <div class="commands">
 {% highlight ruby %}
 task_definition "example-web" do
@@ -67,7 +67,7 @@ task_definition "example-web" do
   variables(
     family: task_definition_name,
     name: "web",
-    awslogs_group: "example-web",
+    awslogs_group: "ecs/example-web",
     awslogs_stream_prefix: "example",
     command: ["bin/web"]
   )

data/docs/_includes/subnav.html

@@ -21,9 +21,11 @@
                 <li><a href="{% link _docs/ufo-init.md %}">ufo init</a></li>
                 <li><a href="{% link _docs/ufo-ship.md %}">ufo ship</a></li>
                 <li><a href="{% link _docs/ufo-ships.md %}">ufo ships</a></li>
+                <li><a href="{% link _docs/ufo-deploy.md %}">ufo deploy</a></li>
                 <li><a href="{% link _docs/ufo-scale.md %}">ufo scale</a></li>
                 <li><a href="{% link _docs/ufo-destroy.md %}">ufo destroy</a></li>
                 <li><a href="{% link _docs/ufo-docker-build.md %}">ufo docker build</a></li>
+                <li><a href="{% link _docs/ufo-docker-push.md %}">ufo docker push</a></li>
                 <li><a href="{% link _docs/ufo-docker-base.md %}">ufo docker base</a></li>
                 <li><a href="{% link _docs/ufo-docker-name.md %}">ufo docker name</a></li>
                 <li><a href="{% link _docs/ufo-docker-clean.md %}">ufo docker clean</a></li>
@@ -37,6 +39,7 @@
         <li><a href="{% link _docs/variables.md %}">Shared Variables</a></li>
         <li><a href="{% link _docs/helpers.md %}">Helpers</a></li>
         <li><a href="{% link _docs/conventions.md %}">Conventions</a></li>
+        <li><a href="{% link _docs/auto-completion.md %}">Auto-Completion</a></li>
         <li><a href="{% link _docs/run-in-pieces.md %}">Run In Pieces</a></li>
         <li><a href="{% link _docs/single-task.md %}">Run Single Task</a></li>
         <li><a href="{% link _docs/migrations.md %}">Database Migrations</a></li>

data/docs/_includes/summary.html

@@ -12,8 +12,8 @@
 
               <ol class="landing-summary">
                 <li>Builds a docker image.</li>
-                <li>Generates and registers the ECS template definition.</li>
-                <li>Deploys the ECS template definition to the ECS service.</li>
+                <li>Registers the ECS template definition.</li>
+                <li>Deploys to ECS.</li>
               </ol>
             </div>
         </div>

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

@@ -4,8 +4,6 @@ Option  | Description
 `--task`  | By convention ufo uses the same name for both the ECS service and task definition. You can override this convention with this option.  The conventions are covered on the [Conventions]({% link _docs/conventions.md %}) page.
 `--target-group`  | The ELB target group to use for the ECS service. This is respected if the ECS service is being created the first time. If the ECS service already exists, this option gets ignored.
 `--target-group-prompt`  | This boolean option allows you to bypass setting the ELB target group if desired.
-`--docker`  | This boolean option determines whether to build the docker image first as part of the ship process.
-`--tasks`  | This boolean option determines where to build and register the task definitions.
 `--wait`  | This boolean option determines if ufo blocks and waits until the service has been deployed before continuing.
 `--pretty`  | This boolean option determines ufo generates the task definitions in output in a pretty human readable format.
 `--stop-old-tasks`  | This boolean option determines if ufo will call ecs stop-task on the old tasks after deployment. Sometimes old tasks hang around for a little bit with ECS this forces them along a little quicker.

data/docs/docs.md

@@ -4,7 +4,11 @@ title: Docs
 
 ### Overview
 
-Ufo is a tool that makes building and shipping Docker containers to AWS ECS super easy. Essentially, ufo builds the docker container image, registers that image to ECS as a task definition, and then deploys that registered task definition to ECS by updating the service. Ufo provides a `ufo ship` command that does all of this.
+Ufo is a tool that makes building and shipping Docker containers to AWS ECS super easy. Ufo provides a `ufo ship` command that does this. Essentially:
+
+1. ufo builds the docker container image
+2. registers that image to ECS as a task definition
+3. deploys that registered task definition to ECS by updating the service.
 
 Ufo was built directly from real life production use cases after seeing the same patterns repeated over and over. Ufo enables you to write the AWS task definition json format file in ERB, an easy templating language.  This allows you to reuse the ufo tool with multiple applications and only put the truly application specific business logic in each app code base.
 

data/docs/quick-start.md

@@ -6,26 +6,35 @@ In a hurry? No sweat! Here's a quick start to using ufo that takes only a few mi
 
 ```sh
 gem install ufo
-git clone https:///github.com/tongueroo/hi.git
+git clone https://github.com/tongueroo/hi.git
 cd hi
 ufo init --app=hi --image=tongueroo/hi
 ufo ship hi-web
 ```
 
+### What Happened
+
+The `ufo ship hi-web` command does the following:
+
+1. Builds the Docker image and pushes it to a registry
+2. Builds the ECS task definitions and registry them to ECS
+3. Updates the ECS Service
+
 You should see something similar to this:
 
 ```
 $ ufo init --app=hi --image=tongueroo/hi
 Setting up ufo project...
-created: ./bin/deploy
-created: ./Dockerfile
-created: ./ufo/settings.yml
-created: ./ufo/task_definitions.rb
-created: ./ufo/templates/main.json.erb
-created: ./ufo/variables/base.rb
-created: ./ufo/variables/prod.rb
-created: ./ufo/variables/stag.rb
-created: ./.env
+      create  .env
+      create  .ufo/settings.yml
+      create  .ufo/task_definitions.rb
+      create  .ufo/templates/main.json.erb
+      create  .ufo/variables/base.rb
+      create  .ufo/variables/development.rb
+      create  .ufo/variables/production.rb
+      create  Dockerfile
+      create  bin/deploy
+      append  .gitignore
 Starter ufo files created.
 $ ufo ship hi-web
 Building docker image with:

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

@@ -0,0 +1,27 @@
+# More info: http://ufoships.com/docs/ufo-settings/
+# The base config is treated special. It gets included the other environments automatically.
+# Yaml also directly supports merging with & and <<* syntax but doing it automatically
+# for a cleaner syntax.
+base:
+  image: <%= @image %>
+  # clean_keep: 30
+  # ecr_keep: 30
+  # defaults when an new ECS service is created by ufo ship
+  new_service:
+    maximum_percent: 200
+    minimum_healthy_percent: 100
+    desired_count: 1
+
+development:
+  # cluster: dev
+  # When you have AWS_PROFILE set to one of these values, ufo will switch to the desired
+  # environment. This prevents you from switching AWS_PROFILE, forgetting to
+  # also switch UFO_ENV, and accidentally deploying to production vs development.
+  # aws_profiles:
+  #   - dev_profile1
+  #   - dev_profile2
+
+production:
+  # cluster: prod
+  # aws_profiles:
+  #   - prod_profile

data/lib/ufo.rb

@@ -4,14 +4,18 @@ require 'deep_merge'
 require 'colorize'
 require 'fileutils'
 
+$:.unshift(File.expand_path("../../vendor/render_me_pretty/lib", __FILE__))
+require "render_me_pretty"
+
 module Ufo
-  autoload :Env, 'ufo/env'
+  autoload :Core, 'ufo/core'
   autoload :Default, 'ufo/default'
   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 :CLI, 'ufo/cli'
   autoload :Help, 'ufo/help'
   autoload :Ship, 'ufo/ship'
@@ -20,12 +24,15 @@ module Ufo
   autoload :DSL, 'ufo/dsl'
   autoload :Scale, 'ufo/scale'
   autoload :LogGroup, 'ufo/log_group'
+  autoload :ECS, 'ufo/ecs'
 
   autoload :Docker, 'ufo/docker'
   autoload :Ecr, 'ufo/ecr'
   autoload :Tasks, 'ufo/tasks'
   autoload :Completion, "ufo/completion"
   autoload :Completer, "ufo/completer"
+  autoload :Upgrade3, "ufo/upgrade3"
+
+  extend Core
 end
 
-Ufo::Env.setup!

data/lib/ufo/cli.rb

@@ -6,64 +6,67 @@ module Ufo
     class_option :verbose, type: :boolean
     class_option :mute, type: :boolean
     class_option :noop, type: :boolean
-    class_option :project_root, type: :string, default: '.'
     class_option :cluster, desc: "Cluster.  Overrides ufo/settings.yml."
 
-    desc "docker [ACTION]", "docker related tasks"
+    desc "docker SUBCOMMAND", "docker related tasks"
     long_desc Help.text(:docker)
     subcommand "docker", Docker
 
-    desc "tasks [ACTION]", "task definition related tasks"
+    desc "tasks SUBCOMMAND", "task definition related tasks"
     long_desc Help.text(:tasks)
     subcommand "tasks", Tasks
 
-    desc "init", "setup initial ufo files"
-    option :image, type: :string, required: true, desc: "Docker image name without the tag. Example: tongueroo/hi. Configures ufo/settings.yml"
-    option :app, type: :string, required: true, desc: "App name. Preferably one word. Used in the generated ufo/task_definitions.rb."
     long_desc Help.text(:init)
-    def init
-      Init.new(options).setup
+    Init.cli_options.each do |args|
+      option *args
     end
+    register(Init, "init", "new", "setup initial ufo files")
 
-    # common options to ship and ships command
+    # common options to deploy. ship, and ships command
     ship_options = Proc.new do
       option :task, desc: "ECS task name, to override the task name convention."
       option :target_group, desc: "ELB Target Group ARN."
       option :target_group_prompt, type: :boolean, desc: "Enable Target Group ARN prompt", default: true
-      option :docker, type: :boolean, desc: "Enable docker build and push", default: true
-      option :tasks, type: :boolean, desc: "Enable tasks build and register", default: true
       option :wait, type: :boolean, desc: "Wait for deployment to complete", default: false
       option :pretty, type: :boolean, default: true, desc: "Pretty format the json for the task definitions"
       option :stop_old_tasks, type: :boolean, default: false, desc: "Stop old tasks after waiting for deploying to complete"
       option :ecr_keep, type: :numeric, desc: "ECR specific cleanup of old images.  Specifies how many images to keep.  Only runs if the images are ECR images. Defaults keeps all images."
     end
 
-    desc "ship [SERVICE]", "builds and ships container image to the ECS service"
+    desc "deploy SERVICE", "deploys task definition to ECS service without re-building the definition"
+    long_desc Help.text(:deploy)
+    ship_options.call
+    def deploy(service)
+      task_definition = options[:task] || service # convention
+      Tasks::Register.register(task_definition, options)
+      ship = Ship.new(service, task_definition, options)
+      ship.deploy
+    end
+
+    desc "ship SERVICE", "builds and ships container image to the ECS service"
     long_desc Help.text(:ship)
     ship_options.call
     def ship(service)
       builder = build_docker
 
       task_definition = options[:task] || service # convention
-      Tasks::Builder.register(task_definition, options) if options[:tasks]
-      LogGroup.new(task_definition, options).create
+      Tasks::Builder.ship(task_definition, options)
       ship = Ship.new(service, task_definition, options)
       ship.deploy
 
       cleanup(builder.image_name)
     end
 
-    desc "ships [LIST-OF-SERVICES]", "builds and ships same container image to multiple ECS services"
+    desc "ships [LIST_OF_SERVICES]", "builds and ships same container image to multiple ECS services"
     long_desc Help.text(:ships)
     ship_options.call
     def ships(*services)
       builder = build_docker
 
       services.each_with_index do |service|
-        service_name, task_defintion_name = service.split(':')
-        task_definition = task_defintion_name || service_name # convention
-        Tasks::Builder.register(task_definition, options) if options[:tasks]
-        LogGroup.new(task_definition, options).create
+        service_name, task_definition_name = service.split(':')
+        task_definition = task_definition_name || service_name # convention
+        Tasks::Builder.ship(task_definition, options)
         ship = Ship.new(service, task_definition, options)
         ship.deploy
       end
@@ -71,17 +74,17 @@ module Ufo
       cleanup(builder.image_name)
     end
 
-    desc "task [TASK_DEFINITION]", "runs a one time task"
+    desc "task TASK_DEFINITION", "runs a one time task"
     long_desc Help.text(:task)
     option :docker, type: :boolean, desc: "Enable docker build and push", default: true
     option :command, type: :array, desc: "Override the command used for the container"
     def task(task_definition)
       Docker::Builder.build(options)
-      Tasks::Builder.register(task_definition, options)
+      Tasks::Builder.ship(task_definition, options)
       Task.new(task_definition, options).run
     end
 
-    desc "destroy [SERVICE]", "destroys the ECS service"
+    desc "destroy SERVICE", "destroys the ECS service"
     long_desc Help.text(:destroy)
     option :sure, type: :boolean, desc: "By pass are you sure prompt."
     def destroy(service)
@@ -89,7 +92,7 @@ module Ufo
       Destroy.new(service, options).bye
     end
 
-    desc "scale [SERVICE] [COUNT]", "scale the ECS service"
+    desc "scale SERVICE COUNT", "scale the ECS service"
     long_desc Help.text(:scale)
     def scale(service, count)
       Scale.new(service, count, options).update
@@ -107,6 +110,12 @@ module Ufo
       Completer::Script.generate
     end
 
+    desc "upgrade3", "upgrades from version 2 and below to 3"
+    long_desc Help.text("upgrade3")
+    def upgrade3
+      Upgrade3.new(options).run
+    end
+
     desc "version", "Prints version number of installed ufo"
     def version
       puts VERSION
@@ -115,16 +124,12 @@ module Ufo
     no_tasks do
       def build_docker
         builder = Docker::Builder.new(options)
-        if options[:docker]
-          builder.build
-          builder.push
-        end
+        builder.build
+        builder.push
         builder
       end
 
       def cleanup(image_name)
-        return unless options[:docker]
-
         Docker::Cleaner.new(image_name, options).cleanup
         Ecr::Cleaner.new(image_name, options).cleanup
       end