hako 0.13.3 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1240601c96556b2eab4b5dc18657b2d3509d07d
-  data.tar.gz: 90672d6874a9b57003cf06ccfd107a33293101b0
+  metadata.gz: dcee254b9d6c4c81d6d480835e3c48ea7c73285b
+  data.tar.gz: 2b8626bbf5480ed279e1872c757f7932f230a842
 SHA512:
-  metadata.gz: 6e45448ebe0cabccf05c76cb61b784d3e4178010672ddacd6135f5409027c65df658ec261ec0b17d3b75a8f65f460e3bb51595a723f50e1d9541349d17d29d02
-  data.tar.gz: 22ffc83a6c2e3adee2d1aa3827b084307b5559457b3aec6897c9950f93d88eed384bd0399aec5ea40e83763c59933f48e7a62b4b3c3fa74c78549763100d05ab
+  metadata.gz: 6325c0e207a2e5f89baa61f7a83a19840d5a439097ed6ecaf35e48b5b540b9d8ade04a063ac04a574328b323dd74d9dd2129791d9861757cfbf2ffc696dbaf74
+  data.tar.gz: 202c812931f149fd9db14f58facf35b82c6fc40f896ad13b92125aa95c0f87d243dbd248d9596027cda15d0038bb4aacb903e34cf42c90cd2647d3620033df44

data/.yardopts

@@ -0,0 +1 @@
+--private

data/Rakefile

@@ -2,8 +2,10 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
+YARD::Rake::YardocTask.new(:yard)
 
 task :default => [:spec, :rubocop]

data/examples/hello-lb.yml

@@ -24,10 +24,11 @@ app:
         path: hello.env
     PORT: 3000
     MESSAGE: '#{username}-san'
-front:
-  image_tag: hako-nginx
-  memory: 32
-  cpu: 32
+additional_containers:
+  front:
+    image_tag: hako-nginx
+    memory: 32
+    cpu: 32
 scripts:
   - <<: !include front.yml
     locations:

data/examples/hello.yml

@@ -16,11 +16,11 @@ app:
         path: hello.env
     PORT: 3000
     MESSAGE: '#{username}-san'
-front:
-  image_tag: hako-nginx
-  memory: 32
-  cpu: 32
 additional_containers:
+  front:
+    image_tag: hako-nginx
+    memory: 32
+    cpu: 32
   redis:
     image_tag: redis:3.0
     cpu: 64

data/hako.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop', '>= 0.36.0'
+  spec.add_development_dependency 'yard'
 end

data/lib/hako/app_container.rb

@@ -3,10 +3,12 @@ require 'hako/container'
 
 module Hako
   class AppContainer < Container
+    # @return [String]
     def image_tag
       "#{@definition['image']}:#{@definition['tag']}"
     end
 
+    # @return [Fixnum]
     def port
       @definition['port']
     end

data/lib/hako/application.rb

@@ -3,6 +3,12 @@ require 'hako/yaml_loader'
 
 module Hako
   class Application
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] root_path
+    #   @return [Pathname]
+    # @!attribute [r] yaml
+    #   @return [Hash]
     attr_reader :id, :root_path, :yaml
 
     def initialize(yaml_path)

data/lib/hako/commander.rb

@@ -8,10 +8,15 @@ require 'hako/scripts'
 
 module Hako
   class Commander
+    # @param [Application] app
     def initialize(app)
       @app = app
     end
 
+    # @param [Boolean] force
+    # @param [String] tag
+    # @param [Boolean] dry_run
+    # @return [nil]
     def deploy(force: false, tag: 'latest', dry_run: false)
       containers = load_containers(tag, dry_run: dry_run)
       scripts = @app.yaml.fetch('scripts', []).map { |config| load_script(config, dry_run: dry_run) }
@@ -21,8 +26,14 @@ module Hako
       scripts.each { |script| script.deploy_starting(containers) }
       scheduler.deploy(containers)
       scripts.each { |script| script.deploy_finished(containers) }
+      nil
     end
 
+    # @param [Array<String>] commands
+    # @param [String] tag
+    # @param [Hash<String, String>] env
+    # @param [Boolean] dry_run
+    # @return [nil]
     def oneshot(commands, tag:, containers:, env: {}, dry_run: false)
       containers = load_containers(tag, dry_run: dry_run, with: containers)
       scripts = @app.yaml.fetch('scripts', []).map { |config| load_script(config, dry_run: dry_run) }
@@ -37,10 +48,12 @@ module Hako
       exit exit_code
     end
 
+    # @return [nil]
     def status
       load_scheduler(@app.yaml['scheduler'], []).status
     end
 
+    # @return [nil]
     def remove
       scripts = @app.yaml.fetch('scripts', []).map { |config| load_script(config, dry_run: dry_run) }
       load_scheduler(@app.yaml['scheduler'], scripts).remove
@@ -52,6 +65,8 @@ module Hako
     TRAP_SIGNALS = %i[INT TERM].freeze
     class SignalTrapped < StandardError; end
 
+    # @param [Scheduler] scheduler
+    # @yieldreturn [Fixnum]
     def with_oneshot_signal_handlers(scheduler, &block)
       old_handlers = {}
       trapped = false
@@ -77,14 +92,26 @@ module Hako
       exit_code
     end
 
+    # @param [String] tag
+    # @param [Boolean] dry_run
+    # @param [Array<String>, nil] with
+    # @return [Hash<String, Container>]
     def load_containers(tag, dry_run:, with: nil)
       DefinitionLoader.new(@app, dry_run: dry_run).load(tag, with: with)
     end
 
+    # @param [Hash] yaml
+    # @param [Hash] volumes
+    # @param [Boolean] force
+    # @param [Boolean] dry_run
+    # @return [Scheduler]
     def load_scheduler(yaml, scripts, volumes: [], force: false, dry_run: false)
       Loader.new(Hako::Schedulers, 'hako/schedulers').load(yaml.fetch('type')).new(@app.id, yaml, volumes: volumes, scripts: scripts, force: force, dry_run: dry_run)
     end
 
+    # @param [Hash] yaml
+    # @param [Boolean] dry_run
+    # @return [Script]
     def load_script(yaml, dry_run:)
       Loader.new(Hako::Scripts, 'hako/scripts').load(yaml.fetch('type')).new(@app, yaml, dry_run: dry_run)
     end

data/lib/hako/container.rb

@@ -3,8 +3,13 @@ require 'hako/version'
 
 module Hako
   class Container
+    # @!attribute [r] definition
+    #   @return [Hash]
     attr_reader :definition
 
+    # @param [Application] app
+    # @param [Hash] definition
+    # @param [Boolean] dry_run
     def initialize(app, definition, dry_run:)
       @app = app
       @definition = default_config.merge(definition)
@@ -29,10 +34,12 @@ module Hako
       end
     end
 
+    # @return [Hash<String, String>]
     def env
       @expanded_env ||= expand_env(@definition.fetch('env'))
     end
 
+    # @return [Array<Hash>]
     def mount_points
       @definition['mount_points'].map do |mount_point|
         {
@@ -47,6 +54,8 @@ module Hako
 
     PROVIDERS_KEY = '$providers'
 
+    # @param [Hash<String, String>] env
+    # @return [Hash<String, String>]
     def expand_env(env)
       env = env.dup
       provider_types = env.delete(PROVIDERS_KEY) || []
@@ -58,12 +67,15 @@ module Hako
       end
     end
 
+    # @param [Array<Hash>] provider_configs
+    # @return [Array<EnvProvider>]
     def load_providers(provider_configs)
       provider_configs.map do |yaml|
         Loader.new(Hako::EnvProviders, 'hako/env_providers').load(yaml.fetch('type')).new(@app.root_path, yaml)
       end
     end
 
+    # @return [Hash]
     def default_config
       {
         'env' => {},
@@ -74,6 +86,7 @@ module Hako
       }
     end
 
+    # @return [Hash<String, String>]
     def default_labels
       {
         'cc.wanko.hako.version' => VERSION,

data/lib/hako/definition_loader.rb

@@ -6,20 +6,22 @@ require 'hako/loader'
 
 module Hako
   class DefinitionLoader
+    # @param [Application] app
+    # @param [Boolean] dry_run
     def initialize(app, dry_run:)
       @app = app
       @dry_run = dry_run
     end
 
+    # @param [String] tag
+    # @param [Array<String>, nil] with
+    # @return [Hash<String, Container>]
     def load(tag, with: nil)
       additional_containers = @app.yaml.fetch('additional_containers', {})
       container_names = ['app']
       if with
         container_names.concat(with)
       else
-        if @app.yaml.key?('front')
-          container_names << 'front'
-        end
         container_names.concat(additional_containers.keys)
       end
 
@@ -28,6 +30,10 @@ module Hako
 
     private
 
+    # @param [String] tag
+    # @param [Array<String>] container_names
+    # @param [Hash<String, Hash>] additional_containers
+    # @return [Hash<String, Container>]
     def load_containers_from_name(tag, container_names, additional_containers)
       names = Set.new(container_names)
       containers = {}
@@ -37,8 +43,6 @@ module Hako
             case name
             when 'app'
               AppContainer.new(@app, @app.yaml['app'].merge('tag' => tag), dry_run: @dry_run)
-            when 'front'
-              Container.new(@app, @app.yaml.fetch('front'), dry_run: @dry_run)
             else
               Container.new(@app, additional_containers.fetch(name), dry_run: @dry_run)
             end

data/lib/hako/env_expander.rb

@@ -12,10 +12,13 @@ module Hako
     Literal = Struct.new(:literal)
     Variable = Struct.new(:name)
 
+    # @param [Array<EnvProvider>] providers
     def initialize(providers)
       @providers = providers
     end
 
+    # @param [Hash<String, String>] env
+    # @return [Hash<String, String>]
     def expand(env)
       parsed_env = {}
       variables = Set.new
@@ -52,6 +55,8 @@ module Hako
 
     private
 
+    # @param [String] value
+    # @return [Array]
     def parse(value)
       s = StringScanner.new(value)
       tokens = []

data/lib/hako/env_providers/file.rb

@@ -4,6 +4,8 @@ require 'hako/env_provider'
 module Hako
   module EnvProviders
     class File < EnvProvider
+      # @param [Pathname] root_path
+      # @param [Hash<String, Object>] options
       def initialize(root_path, options)
         unless options['path']
           validation_error!('path must be set')
@@ -11,6 +13,8 @@ module Hako
         @path = root_path.join(options['path'])
       end
 
+      # @param [Array<String>] variables
+      # @return [Hash<String, String>]
       def ask(variables)
         env = {}
         read_from_file do |key, val|
@@ -23,6 +27,9 @@ module Hako
 
       private
 
+      # @yieldparam [String] key
+      # @yieldparam [String] val
+      # @return [nil]
       def read_from_file(&block)
         ::File.open(@path) do |f|
           f.each_line do |line|

data/lib/hako/loader.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 module Hako
   class Loader
+    # @param [Module] base_module
+    # @param [String] base_path
     def initialize(base_module, base_path)
       @base_module = base_module
       @base_path = base_path
     end
 
+    # @param [String] name
+    # @return [Module]
     def load(name)
       require "#{@base_path}/#{name}"
       @base_module.const_get(camelize(name))
@@ -13,6 +17,8 @@ module Hako
 
     private
 
+    # @param [String] name
+    # @return [String]
     def camelize(name)
       name.split('_').map(&:capitalize).join('')
     end

data/lib/hako/scheduler.rb

@@ -6,6 +6,12 @@ module Hako
     class ValidationError < Error
     end
 
+    # @param [String] app_id
+    # @param [Hash] options
+    # @param [Hash] volumes
+    # @param [Array<Script>] scripts
+    # @param [Boolean] dry_run
+    # @param [Boolean] force
     def initialize(app_id, options, volumes:, scripts:, dry_run:, force:)
       @app_id = app_id
       @volumes = volumes
@@ -15,10 +21,12 @@ module Hako
       configure(options)
     end
 
+    # @param [Hash] _options
     def configure(_options)
     end
 
-    def deploy(_containers, _options)
+    # @param [Hash<String, Container>] _containers
+    def deploy(_containers)
       raise NotImplementedError
     end
 
@@ -32,6 +40,7 @@ module Hako
 
     private
 
+    # @param [String] message
     def validation_error!(message)
       raise ValidationError.new(message)
     end

data/lib/hako/schedulers/ecs.rb

@@ -13,9 +13,10 @@ module Hako
 
       attr_reader :task
 
+      # @param [Hash<String, Object>] options
       def configure(options)
         @cluster = options.fetch('cluster', DEFAULT_CLUSTER)
-        @desired_count = options.fetch('desired_count') { validation_error!('desired_count must be set') }
+        @desired_count = options.fetch('desired_count', nil)
         region = options.fetch('region') { validation_error!('region must be set') }
         @role = options.fetch('role', nil)
         @ecs = Aws::ECS::Client.new(region: region)
@@ -25,7 +26,12 @@ module Hako
         @container_instance_arn = nil
       end
 
+      # @param [Hash<String, Container>] containers
+      # @return [nil]
       def deploy(containers)
+        unless @desired_count
+          validation_error!('desired_count must be set')
+        end
         front_port = determine_front_port
         @scripts.each { |script| script.deploy_started(containers, front_port) }
         definitions = create_definitions(containers)
@@ -53,6 +59,10 @@ module Hako
         end
       end
 
+      # @param [Hash<String, Container>] containers
+      # @param [Array<String>] commands
+      # @param [Hash<String, String>] env
+      # @return [nil]
       def oneshot(containers, commands, env)
         definitions = create_definitions(containers)
         definitions.each do |definition|
@@ -83,6 +93,7 @@ module Hako
         end
       end
 
+      # @return [nil]
       def stop_oneshot
         if @task
           Hako.logger.warn "Stopping #{@task.task_arn}"
@@ -91,6 +102,7 @@ module Hako
         end
       end
 
+      # @return [nil]
       def status
         service = describe_service
         unless service
@@ -149,6 +161,7 @@ module Hako
         end
       end
 
+      # @return [nil]
       def remove
         service = describe_service
         if service
@@ -163,6 +176,7 @@ module Hako
 
       private
 
+      # @return [Aws::ECS::Types::Service, nil]
       def describe_service
         service = @ecs.describe_services(cluster: @cluster, services: [@app_id]).services[0]
         if service && service.status != 'INACTIVE'
@@ -170,6 +184,7 @@ module Hako
         end
       end
 
+      # @return [Fixnum]
       def determine_front_port
         if @dry_run
           return DEFAULT_FRONT_PORT
@@ -182,6 +197,7 @@ module Hako
         end
       end
 
+      # @return [Fixnum]
       def new_front_port
         max_port = -1
         @ecs.list_services(cluster: @cluster).each do |page|
@@ -203,6 +219,8 @@ module Hako
         end
       end
 
+      # @param [Aws::ECS::Types::Service] service
+      # @return [Fixnum, nil]
       def find_front_port(service)
         task_definition = @ecs.describe_task_definition(task_definition: service.task_definition).task_definition
         container_definitions = {}
@@ -214,6 +232,9 @@ module Hako
         end
       end
 
+      # @param [String] family
+      # @param [Array<Hash>] definitions
+      # @return [Boolean]
       def task_definition_changed?(family, definitions)
         if @force
           return true
@@ -236,6 +257,8 @@ module Hako
         true
       end
 
+      # @param [Hash<String, Hash<String, String>>] actual_volumes
+      # @return [Boolean]
       def different_volumes?(actual_volumes)
         if @volumes.size != actual_volumes.size
           return true
@@ -253,10 +276,15 @@ module Hako
         false
       end
 
+      # @param [Hash] expected_container
+      # @param [Aws::ECS::Types::ContainerDefinition] actual_container
+      # @return [Boolean]
       def different_definition?(expected_container, actual_container)
         EcsDefinitionComparator.new(expected_container).different?(actual_container)
       end
 
+      # @param [Array<Hash>] definitions
+      # @return [Aws::ECS::Types::TaskDefinition, Symbol]
       def register_task_definition(definitions)
         if task_definition_changed?(@app_id, definitions)
           @ecs.register_task_definition(
@@ -269,12 +297,16 @@ module Hako
         end
       end
 
+      # @param [Hash<String, Container>] containers
+      # @return [nil]
       def create_definitions(containers)
         containers.map do |name, container|
           create_definition(name, container)
         end
       end
 
+      # @param [Array<Hash>] definitions
+      # @return [Aws::ECS::Types::TaskDefinition, Symbol]
       def register_task_definition_for_oneshot(definitions)
         family = "#{@app_id}-oneshot"
         if task_definition_changed?(family, definitions)
@@ -288,6 +320,7 @@ module Hako
         end
       end
 
+      # @return [Hash]
       def volumes_definition
         @volumes.map do |name, volume|
           {
@@ -297,6 +330,9 @@ module Hako
         end
       end
 
+      # @param [String] name
+      # @param [Container] container
+      # @return [Hash]
       def create_definition(name, container)
         environment = container.env.map { |k, v| { name: k, value: v } }
         {
@@ -313,6 +349,10 @@ module Hako
         }
       end
 
+      # @param [Aws::ECS::Types::TaskDefinition] task_definition
+      # @param [Array<String>] commands
+      # @param [Hash<String, String>] env
+      # @return [Aws::ECS::Types::Task]
       def run_task(task_definition, commands, env)
         environment = env.map { |k, v| { name: k, value: v } }
         @ecs.run_task(
@@ -332,6 +372,7 @@ module Hako
         ).tasks[0]
       end
 
+      # @return [Fixnum]
       def wait_for_oneshot_finish
         containers = wait_for_task(@task)
         @task = nil
@@ -350,6 +391,8 @@ module Hako
         exit_code
       end
 
+      # @param [Aws::ECS::Types::Task] task
+      # @return [nil]
       def wait_for_task(task)
         task_arn = task.task_arn
         loop do
@@ -385,6 +428,8 @@ module Hako
         end
       end
 
+      # @param [String] container_instance_arn
+      # @return [nil]
       def report_container_instance(container_instance_arn)
         container_instance = @ecs.describe_container_instances(cluster: @cluster, container_instances: [container_instance_arn]).container_instances[0]
         @ec2.describe_tags(filters: [{ name: 'resource-id', values: [container_instance.ec2_instance_id] }]).each do |page|
@@ -397,6 +442,9 @@ module Hako
         end
       end
 
+      # @param [String] task_definition_arn
+      # @param [Fixnum] front_port
+      # @return [Aws::ECS::Types::Service, Symbol]
       def create_or_update_service(task_definition_arn, front_port)
         service = describe_service
         if service.nil?
@@ -435,6 +483,9 @@ module Hako
 
       SERVICE_KEYS = %i[desired_count task_definition].freeze
 
+      # @param [Aws::ECS::Types::Service] service
+      # @param [Hash] params
+      # @return [Boolean]
       def service_changed?(service, params)
         SERVICE_KEYS.each do |key|
           if service.public_send(key) != params[key]
@@ -444,8 +495,11 @@ module Hako
         false
       end
 
+      # @param [Aws::ECS::Types::Service] service
+      # @return [nil]
       def wait_for_ready(service)
         latest_event_id = find_latest_event_id(service.events)
+        Hako.logger.debug "  latest_event_id=#{latest_event_id}"
         loop do
           s = @ecs.describe_services(cluster: service.cluster_arn, services: [service.service_arn]).services[0]
           s.events.each do |e|
@@ -456,6 +510,7 @@ module Hako
           end
           latest_event_id = find_latest_event_id(s.events)
           finished = s.deployments.all? { |d| d.status != 'ACTIVE' }
+          Hako.logger.debug "  latest_event_id=#{latest_event_id}, deployment statuses=#{s.deployments.map(&:status)}"
           if finished
             return
           else
@@ -464,6 +519,8 @@ module Hako
         end
       end
 
+      # @param [Array<Aws::ECS::Types::ServiceEvent>] events
+      # @return [String, nil]
       def find_latest_event_id(events)
         if events.empty?
           nil

data/lib/hako/schedulers/ecs_definition_comparator.rb

@@ -2,6 +2,7 @@
 module Hako
   module Schedulers
     class EcsDefinitionComparator
+      # @param [Hash] expected_container
       def initialize(expected_container)
         @expected_container = expected_container
       end
@@ -11,6 +12,8 @@ module Hako
       ENVIRONMENT_KEYS = %i[name value].freeze
       MOUNT_POINT_KEYS = %i[source_volume container_path read_only].freeze
 
+      # @param [Aws::ECS::Types::ContainerDefinition] actual_container
+      # @return [Boolean]
       def different?(actual_container)
         unless actual_container
           return true
@@ -33,6 +36,10 @@ module Hako
 
       private
 
+      # @param [Hash<String, Object>] expected
+      # @param [Hash<String, Object>] actual
+      # @param [Array<String>] keys
+      # @return [Boolean]
       def different_members?(expected, actual, keys)
         keys.each do |key|
           if actual.public_send(key) != expected[key]
@@ -42,6 +49,10 @@ module Hako
         false
       end
 
+      # @param [Hash<String, Array<Object>>] expected
+      # @param [Hash<String, Array<Object>>] actual
+      # @param [Array<String>] keys
+      # @return [Boolean]
       def different_array?(expected, actual, key, keys)
         if expected[key].size != actual.public_send(key).size
           return true

data/lib/hako/schedulers/ecs_elb.rb

@@ -5,16 +5,22 @@ require 'hako'
 module Hako
   module Schedulers
     class EcsElb
+      # @param [String] app_id
+      # @param [Aws::ElasticLoadBalancing::Client] elb
+      # @param [Hash] elb_config
       def initialize(app_id, elb, elb_config)
         @app_id = app_id
         @elb = elb
         @elb_config = elb_config
       end
 
+      # @return [Aws::ElasticLoadBalancing::Types::LoadBalancerDescription]
       def describe_load_balancer
         @elb.describe_load_balancers(load_balancer_names: [name]).load_balancer_descriptions[0]
       end
 
+      # @param [Fixnum] front_port
+      # @return [nil]
       def find_or_create_load_balancer(front_port)
         if @elb_config
           unless exist?
@@ -40,6 +46,7 @@ module Hako
         end
       end
 
+      # @return [nil]
       def destroy
         if exist?
           @elb.delete_load_balancer(load_balancer_name: name)
@@ -49,6 +56,7 @@ module Hako
         end
       end
 
+      # @return [Boolean]
       def exist?
         describe_load_balancer
         true
@@ -56,6 +64,7 @@ module Hako
         false
       end
 
+      # @return [String]
       def name
         "hako-#{@app_id}"
       end

data/lib/hako/script.rb

@@ -3,32 +3,43 @@ require 'hako/scripts'
 
 module Hako
   class Script
+    # @param [Application] app
+    # @param [Hash] options
+    # @param [Boolean] dry_run
     def initialize(app, options, dry_run:)
       @app = app
       @dry_run = dry_run
       configure(options)
     end
 
+    # @param [Hash<String, Container>] _containers
     def deploy_starting(_containers)
     end
 
+    # @param [Hash<String, Container>] _containers
+    # @param [Fixnum] _front_port
     def deploy_started(_containers, _front_port)
     end
 
+    # @param [Hash<String, Container>] _containers
     def deploy_finished(_containers)
     end
 
+    # @param [Hash<String, Container>] _containers
     def oneshot_starting(_containers)
     end
 
+    # @param [Scheduler] _scheduler
     def oneshot_started(_scheduler)
     end
 
+    # @param [Hash<String, Container>] _containers
     def oneshot_finished(_containers)
     end
 
     private
 
+    # @param [Hash] _options
     def configure(_options)
     end
   end

data/lib/hako/scripts/nginx_front.rb

@@ -8,6 +8,7 @@ module Hako
   module Scripts
     class NginxFront < Script
       S3Config = Struct.new(:region, :bucket, :prefix) do
+        # @param [Hash] options
         def initialize(options)
           self.region = options.fetch('region')
           self.bucket = options.fetch('bucket')
@@ -23,6 +24,8 @@ module Hako
         end
       end
 
+      # @param [Hash<String, Container>] containers
+      # @return [nil]
       def deploy_starting(containers)
         front = containers.fetch('front')
         front.definition['env'].merge!(
@@ -33,6 +36,9 @@ module Hako
         front.links << link_app
       end
 
+      # @param [Hash<String, Container>] containers
+      # @param [Fixnum] front_port
+      # @return [nil]
       def deploy_started(containers, front_port)
         app = containers.fetch('app')
         front = containers.fetch('front')
@@ -43,6 +49,8 @@ module Hako
 
       private
 
+      # @param [Hash] options
+      # @return [nil]
       def configure(options)
         super
         @options = options
@@ -50,18 +58,24 @@ module Hako
         @s3 = S3Config.new(@options.fetch('s3'))
       end
 
+      # @return [String]
       def link_app
         'app:app'
       end
 
+      # @param [Fixnum] front_port
+      # @return [Hash]
       def port_mapping(front_port)
         { container_port: 80, host_port: front_port, protocol: 'tcp' }
       end
 
+      # @param [Fixnum] app_port
+      # @return [String]
       def generate_config(app_port)
         Generator.new(@options, app_port).render
       end
 
+      # @return [Hash]
       def upload_config(front_conf)
         if @dry_run
           Hako.logger.info "Generated configuration:\n#{front_conf}"
@@ -74,38 +88,47 @@ module Hako
         end
       end
 
+      # @return [Aws::S3::Client]
       def s3_client
         @s3_client ||= Aws::S3::Client.new(region: @s3.region)
       end
 
       class Generator
+        # @param [Hash] options
+        # @param [Fixnum] app_port
         def initialize(options, app_port)
           @options = options
           @app_port = app_port
         end
 
+        # @return [String]
         def render
           ERB.new(File.read(nginx_conf_erb), nil, '-').result(binding)
         end
 
         private
 
+        # @return [String]
         def listen_spec
           "app:#{@app_port}"
         end
 
+        # @return [String]
         def templates_directory
           File.expand_path('../../templates', __FILE__)
         end
 
+        # @return [String]
         def nginx_conf_erb
           File.join(templates_directory, 'nginx.conf.erb')
         end
 
+        # @return [String]
         def nginx_location_conf_erb
           File.join(templates_directory, 'nginx.location.conf.erb')
         end
 
+        # @return [Hash<String, Location>]
         def locations
           locs = @options.fetch('locations').dup
           locs.keys.each do |k|
@@ -114,10 +137,14 @@ module Hako
           locs
         end
 
+        # @return [String, nil]
         def client_max_body_size
           @options.fetch('client_max_body_size', nil)
         end
 
+        # @param [String] listen_spec
+        # @param [Location] location
+        # @return [String]
         def render_location(listen_spec, location)
           ERB.new(File.read(nginx_location_conf_erb), nil, '-').result(binding).each_line.map do |line|
             "    #{line}"
@@ -125,10 +152,12 @@ module Hako
         end
 
         class Location
+          # @param [Hash] config
           def initialize(config)
             @config = config
           end
 
+          # @return [Array<String>, nil]
           def allow_only_from
             allow = @config.fetch('allow_only_from', nil)
             if allow

data/lib/hako/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hako
-  VERSION = '0.13.3'
+  VERSION = '0.14.0'
 end

data/lib/hako/yaml_loader.rb

@@ -7,6 +7,8 @@ module Hako
       @current_path = nil
     end
 
+    # @param [String] path
+    # @return [Hash]
     def load(path)
       class_loader = Psych::ClassLoader.new
       scanner = Psych::ScalarScanner.new(class_loader)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hako
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.14.0
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.36.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Deploy Docker container
 email:
 - eagletmt@gmail.com
@@ -93,6 +107,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - README.md
 - Rakefile
@@ -119,7 +134,6 @@ files:
 - lib/hako/loader.rb
 - lib/hako/scheduler.rb
 - lib/hako/schedulers.rb
-- lib/hako/schedulers/echo.rb
 - lib/hako/schedulers/ecs.rb
 - lib/hako/schedulers/ecs_definition_comparator.rb
 - lib/hako/schedulers/ecs_elb.rb
@@ -154,3 +168,4 @@ signing_key:
 specification_version: 4
 summary: Deploy Docker container
 test_files: []
+has_rdoc: 

data/lib/hako/schedulers/echo.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-require 'hako/scheduler'
-
-module Hako
-  module Schedulers
-    class Echo < Scheduler
-      def deploy(containers)
-        app = containers.fetch('app')
-        puts "Deploy #{app.image_tag} with app_port=#{app.port}, force=#{@force}, dry_run=#{@dry_run}"
-        puts 'Environment variables:'
-        app.env.each do |key, val|
-          puts "  #{key}=#{val.inspect}"
-        end
-      end
-
-      def oneshot(containers, commands, env)
-        app = containers.fetch('app')
-        puts "Run #{app.image_tag} with oneshot commands=#{commands.inspect}"
-        puts 'Environment variables:'
-        env.each do |key, val|
-          puts "  #{key}=#{val.inspect}"
-        end
-        0
-      end
-    end
-  end
-end