ufo 1.7.1 → 2.0.0

data/lib/starter_project/ufo/task_definitions.rb

@@ -5,45 +5,34 @@
 # * helper.full_image_name - Docker image name with the tag when docker image is built by ufo. This is defined in ufo/settings.yml.  The helper.full_image_name includes the git sha tongueroo/hi:ufo-[sha].
 # * helper.dockerfile_port - Expose port in the Dockerfile.  Only supports one exposed port, the first one that is encountered.
 #
-# env_vars - is a helper method that generates the proper environment Array of Hashes
-
-# common variables
-common = {
-  image: helper.full_image_name, # includes the git sha tongueroo/hi:ufo-[sha].
-  cpu: 128,
-  memory_reservation: 256,
-  environment: helper.env_file(".env")
-  # another example
-  # environment: helper.env_vars(%Q{
-  #   RAILS_ENV=production
-  #   SECRET_KEY_BASE=secret
-  # })
-}
-
-task_definition "<%= @app %>-web-<%= @env %>" do
+# helper.env_vars - is a helper method that generates the proper environment Array of Hashes
+#
+# More info: http://ufoships.com/docs/helpers/
+#
+task_definition "<%= @app %>-web" do
   source "main" # will use ufo/templates/main.json.erb
-  variables(common.dup.deep_merge(
+  variables(
     family: task_definition_name,
     name: "web",
     container_port: helper.dockerfile_port,
     command: ["bin/web"]
-  ))
+  )
 end
 
-task_definition "<%= @app %>-worker-<%= @env %>" do
+task_definition "<%= @app %>-worker" do
   source "main" # will use ufo/templates/main.json.erb
-  variables(common.dup.deep_merge(
+  variables(
     family: task_definition_name,
     name: "worker",
     command: ["bin/worker"]
-  ))
+  )
 end
 
-task_definition "<%= @app %>-clock-<%= @env %>" do
+task_definition "<%= @app %>-clock" do
   source "main" # will use ufo/templates/main.json.erb
-  variables(common.dup.deep_merge(
+  variables(
     family: task_definition_name,
     name: "clock",
     command: ["bin/clock"]
-  ))
+  )
 end

data/lib/starter_project/ufo/variables/base.rb

@@ -0,0 +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].
+@cpu = 128
+@memory_reservation = 256
+@environment = helper.env_file(".env")

data/lib/starter_project/ufo/variables/prod.rb

@@ -0,0 +1,7 @@
+# Example ufo/variables/prod.rb
+# More info on how variables work: http://ufoships.com/docs/variables/
+@cpu = 256
+@environment = helper.env_vars(%Q{
+  RAILS_ENV=production
+  SECRET_KEY_BASE=secret
+})

data/lib/starter_project/ufo/variables/stag.rb

@@ -0,0 +1,7 @@
+# Example ufo/variables/prod.rb
+# More info on how variables work: http://ufoships.com/docs/variables/
+@cpu = 192
+@environment = helper.env_vars(%Q{
+  RAILS_ENV=staging
+  SECRET_KEY_BASE=secret
+})

data/lib/ufo.rb

@@ -5,6 +5,7 @@ require 'colorize'
 require 'fileutils'
 
 module Ufo
+  autoload :Env, 'ufo/env'
   autoload :Defaults, 'ufo/defaults'
   autoload :AwsServices, 'ufo/aws_services'
   autoload :Command, 'ufo/command'
@@ -23,3 +24,5 @@ module Ufo
   autoload :Ecr, 'ufo/ecr'
   autoload :Tasks, 'ufo/tasks'
 end
+
+Ufo::Env.setup!

data/lib/ufo/default/settings.yml

@@ -0,0 +1,25 @@
+# More info: http://ufoships.com/docs/ufo-settings/
+#
+# image:
+# clean_keep: 30
+# ecr_keep: 30
+
+# aws_profile_ufo_env_map:
+#   default: prod
+#   # More examples:
+#   aws_profile1: prod
+#   aws_profile2: stag
+#   aws_profile3: dev
+
+# ufo_env_cluster_map:
+#   default: prod
+#   # More examples:
+#   aws_profile1: prod
+#   aws_profile2: stag
+#   aws_profile3: dev
+
+# defaults when an new ECS service is created by ufo ship
+new_service:
+  maximum_percent: 200
+  minimum_healthy_percent: 100
+  desired_count: 1

data/lib/ufo/defaults.rb

@@ -8,18 +8,19 @@ module Ufo
   #
   # So @options must be set
   module Defaults
-    # image: 123456789.dkr.ecr.us-east-1.amazonaws.com/sinatra
-    # # service to cluster mapping, overrides default cluster cli overrides this
-    # service_cluster:
-    #   default: prod-lo
-    #   hi-web-prod: prod-hi
-    #   hi-clock-prod: prod-lo
-    #   hi-worker-prod: prod-lo
+    # The default cluster normally defaults to the UFO_ENV value.
+    # But it can be overriden by ufo/settings.yml ufo_env_cluster_map
     #
-    # Assumes that @service is set in the class that the Defaults module is included in.
+    # Covered: http://localhost:4000/docs/settings/
     def default_cluster
-      service_cluster = settings.data["service_cluster"]
-      service_cluster[@service] || service_cluster["default"]
+      #
+
+      map = settings.data["ufo_env_cluster_map"]
+      if map
+        ecs_cluster = map[UFO_ENV] || map["default"]
+      end
+
+      ecs_cluster || UFO_ENV
     end
 
     # These default service values only are used when a service is created by `ufo`

data/lib/ufo/dsl/task_definition.rb

@@ -19,10 +19,41 @@ module Ufo
       end
 
       def build
+        load_variables
         instance_eval(&@block)
         erb_result(source_path)
       end
 
+      def load_variables
+        load_variables_file("base")
+        load_variables_file(UFO_ENV)
+      end
+
+      # Load the variables defined in ufo/variables/* to make available in the
+      # template blocks in ufo/templates/*.
+      #
+      # Example:
+      #
+      #   `ufo/variables/base.rb`:
+      #     @name = "docker-process-name"
+      #     @image = "docker-image-name"
+      #
+      #   `ufo/templates/main.json.erb`:
+      #   {
+      #     "containerDefinitions": [
+      #       {
+      #          "name": "<%= @name %>",
+      #          "image": "<%= @image %>",
+      #      ....
+      #   }
+      #
+      # NOTE: Only able to make instance variables avaialble with instance_eval
+      #   Wasnt able to make local variables available.
+      def load_variables_file(filename)
+        path = "#{@project_root}/ufo/variables/#{filename}.rb"
+        instance_eval(IO.read(path)) if File.exist?(path)
+      end
+
       def erb_result(path)
         template = IO.read(path)
         begin

data/lib/ufo/env.rb

@@ -0,0 +1,18 @@
+class Ufo::Env
+  def self.setup!(project_root='.')
+    # Ensures that  UFO_ENV is always set to a default value.
+    # For Ufo::Env.setup! we do not need to check if we're in a ufo project
+    # Because we could not be at first. For example when: ufo init is first called.
+    # Other uses of Ufo::Settings assumes that we should be in a ufo project.
+    settings = Ufo::Settings.new(project_root, false).data
+    map = settings['aws_profile_ufo_env_map']
+
+    if map
+      ufo_env = map[ENV['AWS_PROFILE']] || map['default']
+    end
+    ufo_env ||= 'prod' # defaults to prod
+    ufo_env = ENV['UFO_ENV'] if ENV['UFO_ENV'] # highest precedence
+
+    Kernel.const_set(:UFO_ENV, ufo_env)
+  end
+end

data/lib/ufo/settings.rb

@@ -2,31 +2,37 @@ require 'yaml'
 
 module Ufo
   class Settings
-    def initialize(project_root='.')
+    def initialize(project_root='.', check_ufo_project=true)
       @project_root = project_root
+      @check_ufo_project = check_ufo_project
     end
 
     # data contains the settings.yml config.  The order or precedence for settings
     # is the project ufo/settings.yml and then the ~/.ufo/settings.yml.
     def data
-      return @data if @data
+      return @settings_yaml if @settings_yaml
 
-      if File.exist?(settings_path)
-        @data = YAML.load_file(settings_path)
-        @data = user_settings.merge(@data)
-      else
-        puts "ERROR: No settings file at #{settings_path}.  Are you sure you are in a project with ufo setup?"
+      if @check_ufo_project && !File.exist?(project_settings_path)
+        puts "ERROR: No settings file at #{project_settings_path}.  Are you sure you are in a project with ufo setup?"
         puts "Please create a settings file via: ufo init"
         exit 1
       end
-    end
 
-    def user_settings
-      path = "#{ENV['HOME']}/.ufo/settings.yml"
-      File.exist?(path) ? YAML.load_file(path) : {}
+      project = File.exist?(project_settings_path) ?
+                  YAML.load_file(project_settings_path) :
+                  {}
+
+      user_file = "#{ENV['HOME']}/.ufo/settings.yml"
+      user = File.exist?(user_file) ? YAML.load_file(user_file) : {}
+
+      default_file = File.expand_path("../default/settings.yml", __FILE__)
+      default = YAML.load_file(default_file)
+
+      @settings_yaml = default.merge(user.merge(project))
     end
 
-    def settings_path
+  private
+    def project_settings_path
       "#{@project_root}/ufo/settings.yml"
     end
   end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "1.7.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -197,6 +197,7 @@ files:
 - docs/_docs/ufo-docker-build.md
 - docs/_docs/ufo-docker-clean.md
 - docs/_docs/ufo-docker-name.md
+- docs/_docs/ufo-env.md
 - docs/_docs/ufo-help.md
 - docs/_docs/ufo-init.md
 - docs/_docs/ufo-scale.md
@@ -204,6 +205,7 @@ files:
 - docs/_docs/ufo-ships.md
 - docs/_docs/ufo-tasks-build.md
 - docs/_docs/ufo-tasks-register.md
+- docs/_docs/variables.md
 - docs/_includes/about.html
 - docs/_includes/commands.html
 - docs/_includes/contact.html
@@ -234,6 +236,7 @@ files:
 - docs/_layouts/default.html
 - docs/_layouts/style.css
 - docs/articles.md
+- docs/bin/web
 - docs/css/font-awesome/css/font-awesome.css
 - docs/css/font-awesome/css/font-awesome.min.css
 - docs/css/font-awesome/fonts/FontAwesome.otf
@@ -250,8 +253,6 @@ files:
 - docs/img/tutorials/ecs-console-task-definitions.png
 - docs/img/tutorials/ecs-console-ufo-ship.png
 - docs/img/tutorials/ecs-console-ufo-ships.png
-- docs/img/tutorials/ufo-init.png
-- docs/img/tutorials/ufo-tasks-build.png
 - docs/index.html
 - docs/js/bootstrap.js
 - docs/js/bootstrap.min.js
@@ -273,11 +274,15 @@ files:
 - lib/starter_project/ufo/settings.yml
 - lib/starter_project/ufo/task_definitions.rb
 - lib/starter_project/ufo/templates/main.json.erb
+- lib/starter_project/ufo/variables/base.rb
+- lib/starter_project/ufo/variables/prod.rb
+- lib/starter_project/ufo/variables/stag.rb
 - lib/ufo.rb
 - lib/ufo/aws_services.rb
 - lib/ufo/cli.rb
 - lib/ufo/cli/help.rb
 - lib/ufo/command.rb
+- lib/ufo/default/settings.yml
 - lib/ufo/defaults.rb
 - lib/ufo/destroy.rb
 - lib/ufo/docker.rb
@@ -292,6 +297,7 @@ files:
 - lib/ufo/ecr.rb
 - lib/ufo/ecr/auth.rb
 - lib/ufo/ecr/cleaner.rb
+- lib/ufo/env.rb
 - lib/ufo/init.rb
 - lib/ufo/log_group.rb
 - lib/ufo/scale.rb