hako 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eeaab8400e80caccbf550eed190e25ca59d729f04f450c0fa3c34596036a0af
-  data.tar.gz: '039cc2afb69aacceaa40976bb74dca8be034dc4e4780423c4a5d30040f17775f'
+  metadata.gz: 8da04c31fe7625fb6d07dc567a54ecd07100fc84b434bd390137ab5801a41bdb
+  data.tar.gz: aae515841f829f80332241e8187973a2f38fa79ae51ce217a92a2cac911970e2
 SHA512:
-  metadata.gz: 84b31ceebf0c3bc2cc3262b8b977d092269b527c6d33c1082ee01715514e61c8e439a1c78390e96590cf5d8777a44e120d631bd269269c3219c0b7818109f5d2
-  data.tar.gz: 136f00906ce0b1e94a67d4fe6a0919efecae7744a402fba58f0cbd4ff86f9dd6f8187a6bdd68ca52002f000c998efd87404dcf5536918360fac047a5d900db47
+  metadata.gz: 9383d706cc18370a6878d3206ce526cd0c99ec93c636fbc0c15ab8bb34360537785f9e97a96a8298c85cdd595d18b7af351cf323c57b4a0371de30662f18bbea
+  data.tar.gz: 12bb5b4c2ed31c2dfdf6453a2a188ab3f046833aa26f26072a273d17eac95b2aff72dfe92d130bffcc9d55396738d1c6defd7a024ea5ee23f3ea9ca0f87930f2

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2.9.0 (2019-04-03)
+## New features
+- Add `remove_starting` method to Hako::Script which is called when `hako remove` starts
+- Support sharing load balancers
+  - When `elb_v2` field has `load_balancer_name` but doesn't have `target_group_name`, hako will manage only the target group and doesn't touch the load balancer.
+  - This is useful when one load balancer is shared with multiple target groups and some of them is deployed by hako.
+  - See [examples/hello-shared-alb.jsonnet](examples/hello-shared-alb.jsonnet)
+
+## Changes
+- When `load_balancer_name` is specified and `target_group_name` is not, the default `target_group_name` is changed from `load_balancer_name` to `hako-#{app_id}`.
+  - If you use `load_balancer_name` field only, you must specify `target_group_name` field too.
+
 # 2.8.0 (2019-03-17)
 ## New features
 - Add `deploy_failed` method to Hako::Script which is called when `hako deploy` fails

data/examples/hello-shared-alb.jsonnet

@@ -0,0 +1,50 @@
+{
+  scheduler: {
+    type: 'ecs',
+    region: 'ap-northeast-1',
+    cluster: 'eagletmt',
+    desired_count: 2,
+    role: 'ecsServiceRole',
+    elb_v2: {
+      // Use existing load balancer
+      load_balancer_name: 'hello-shared-alb',
+      // VPC id where the target group is located
+      vpc_id: 'vpc-WWWWWWWW',
+      // Health check path of the target group
+      health_check_path: '/site/sha',
+      target_group_attributes: {
+        // http://docs.aws.amazon.com/en_us/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes
+        'deregistration_delay.timeout_seconds': '20',
+      },
+    },
+  },
+  app: {
+    image: 'ryotarai/hello-sinatra',
+    memory: 128,
+    cpu: 256,
+    env: {
+      PORT: '3000',
+    },
+    secrets: [{
+      name: 'MESSAGE',
+      value_from: 'arn:aws:ssm:ap-northeast-1:012345678901:parameter/hako/hello-shared-alb/secret-message',
+    }],
+  },
+  sidecars: {
+    front: {
+      image_tag: 'hako-nginx',
+      memory: 32,
+      cpu: 32,
+    },
+  },
+  scripts: [
+    (import 'front.libsonnet') + {
+      backend_port: 3000,
+      locations: {
+        '/': {
+          allow_only_from: ['10.0.0.0/24'],
+        },
+      },
+    },
+  ],
+}

data/lib/hako/commander.rb

@@ -70,6 +70,7 @@ module Hako
     # @return [nil]
     def remove(dry_run:)
       scripts = @app.definition.fetch('scripts', []).map { |config| load_script(config, dry_run: dry_run) }
+      scripts.each(&:remove_starting)
       load_scheduler(@app.definition['scheduler'], scripts, dry_run: dry_run).remove
       scripts.each(&:after_remove)
     end

data/lib/hako/schedulers/ecs.rb

@@ -103,6 +103,7 @@ module Hako
           validation_error!('desired_count must be set')
         end
         front_port = determine_front_port
+        ecs_elb_client.find_or_create_load_balancer(front_port)
         @scripts.each { |script| script.deploy_started(containers, front_port) }
         definitions = create_definitions(containers)
 
@@ -886,7 +887,6 @@ module Hako
           params[:desired_count] = 0
         end
         if ecs_elb_client.find_or_create_load_balancer(front_port)
-          ecs_elb_client.modify_attributes
           params[:load_balancers] = [ecs_elb_client.load_balancer_params_for_service]
         end
         if @service_discovery

data/lib/hako/schedulers/ecs_elb_v2.rb

@@ -51,7 +51,7 @@ module Hako
         end
 
         load_balancer = describe_load_balancer
-        unless load_balancer
+        if !load_balancer_given? && !load_balancer
           tags = @elb_v2_config.fetch('tags', {}).map { |k, v| { key: k, value: v.to_s } }
 
           elb_type = @elb_v2_config.fetch('type', nil)
@@ -78,7 +78,7 @@ module Hako
         end
 
         target_group = describe_target_group
-        unless target_group
+        if !target_group_given? && !target_group
           elb_type = @elb_v2_config.fetch('type', nil)
           target_group = if elb_type == 'network'
                            elb_client.create_target_group(
@@ -102,23 +102,25 @@ module Hako
           Hako.logger.info "Created target group #{target_group.target_group_arn}"
         end
 
-        listener_ports = elb_client.describe_listeners(load_balancer_arn: load_balancer.load_balancer_arn).flat_map { |page| page.listeners.map(&:port) }
-        @elb_v2_config.fetch('listeners').each do |l|
-          params = {
-            load_balancer_arn: load_balancer.load_balancer_arn,
-            protocol: l.fetch('protocol'),
-            port: l.fetch('port'),
-            ssl_policy: l['ssl_policy'],
-            default_actions: [{ type: 'forward', target_group_arn: target_group.target_group_arn }],
-          }
-          certificate_arn = l.fetch('certificate_arn', nil)
-          if certificate_arn
-            params[:certificates] = [{ certificate_arn: certificate_arn }]
-          end
+        unless load_balancer_given?
+          listener_ports = elb_client.describe_listeners(load_balancer_arn: load_balancer.load_balancer_arn).flat_map { |page| page.listeners.map(&:port) }
+          @elb_v2_config.fetch('listeners').each do |l|
+            params = {
+              load_balancer_arn: load_balancer.load_balancer_arn,
+              protocol: l.fetch('protocol'),
+              port: l.fetch('port'),
+              ssl_policy: l['ssl_policy'],
+              default_actions: [{ type: 'forward', target_group_arn: target_group.target_group_arn }],
+            }
+            certificate_arn = l.fetch('certificate_arn', nil)
+            if certificate_arn
+              params[:certificates] = [{ certificate_arn: certificate_arn }]
+            end
 
-          unless listener_ports.include?(params[:port])
-            listener = elb_client.create_listener(params).listeners[0]
-            Hako.logger.info("Created listener #{listener.listener_arn}")
+            unless listener_ports.include?(params[:port])
+              listener = elb_client.create_listener(params).listeners[0]
+              Hako.logger.info("Created listener #{listener.listener_arn}")
+            end
           end
         end
 
@@ -131,58 +133,63 @@ module Hako
           return nil
         end
 
-        load_balancer = describe_load_balancer
-        subnets = @elb_v2_config.fetch('subnets').sort
-        if load_balancer && subnets != load_balancer.availability_zones.map(&:subnet_id).sort
-          if @dry_run
-            Hako.logger.info("elb_client.set_subnets(load_balancer_arn: #{load_balancer.load_balancer_arn}, subnets: #{subnets}) (dry-run)")
-          else
-            Hako.logger.info("Updating ELBv2 subnets to #{subnets}")
-            elb_client.set_subnets(load_balancer_arn: load_balancer.load_balancer_arn, subnets: subnets)
+        unless load_balancer_given?
+          load_balancer = describe_load_balancer
+          subnets = @elb_v2_config.fetch('subnets').sort
+          if load_balancer && subnets != load_balancer.availability_zones.map(&:subnet_id).sort
+            if @dry_run
+              Hako.logger.info("elb_client.set_subnets(load_balancer_arn: #{load_balancer.load_balancer_arn}, subnets: #{subnets}) (dry-run)")
+            else
+              Hako.logger.info("Updating ELBv2 subnets to #{subnets}")
+              elb_client.set_subnets(load_balancer_arn: load_balancer.load_balancer_arn, subnets: subnets)
+            end
           end
-        end
 
-        new_listeners = @elb_v2_config.fetch('listeners')
-        if load_balancer
-          current_listeners = elb_client.describe_listeners(load_balancer_arn: load_balancer.load_balancer_arn).listeners
-          new_listeners.each do |new_listener|
-            current_listener = current_listeners.find { |l| l.port == new_listener['port'] }
-            if current_listener && new_listener['ssl_policy'] && new_listener['ssl_policy'] != current_listener.ssl_policy
-              if @dry_run
-                Hako.logger.info("elb_client.modify_listener(listener_arn: #{current_listener.listener_arn}, ssl_policy: #{new_listener['ssl_policy']}) (dry-run)")
-              else
-                Hako.logger.info("Updating ELBv2 listener #{new_listener['port']} ssl_policy to #{new_listener['ssl_policy']}")
-                elb_client.modify_listener(listener_arn: current_listener.listener_arn, ssl_policy: new_listener['ssl_policy'])
+          new_listeners = @elb_v2_config.fetch('listeners')
+          if load_balancer
+            current_listeners = elb_client.describe_listeners(load_balancer_arn: load_balancer.load_balancer_arn).listeners
+            new_listeners.each do |new_listener|
+              current_listener = current_listeners.find { |l| l.port == new_listener['port'] }
+              if current_listener && new_listener['ssl_policy'] && new_listener['ssl_policy'] != current_listener.ssl_policy
+                if @dry_run
+                  Hako.logger.info("elb_client.modify_listener(listener_arn: #{current_listener.listener_arn}, ssl_policy: #{new_listener['ssl_policy']}) (dry-run)")
+                else
+                  Hako.logger.info("Updating ELBv2 listener #{new_listener['port']} ssl_policy to #{new_listener['ssl_policy']}")
+                  elb_client.modify_listener(listener_arn: current_listener.listener_arn, ssl_policy: new_listener['ssl_policy'])
+                end
               end
             end
           end
-        end
 
-        if @elb_v2_config.key?('load_balancer_attributes')
-          attributes = @elb_v2_config.fetch('load_balancer_attributes').map { |key, value| { key: key, value: value } }
-          if @dry_run
-            if load_balancer
-              Hako.logger.info("elb_client.modify_load_balancer_attributes(load_balancer_arn: #{load_balancer.load_balancer_arn}, attributes: #{attributes.inspect}) (dry-run)")
+          if @elb_v2_config.key?('load_balancer_attributes')
+            attributes = @elb_v2_config.fetch('load_balancer_attributes').map { |key, value| { key: key, value: value } }
+            if @dry_run
+              if load_balancer
+                Hako.logger.info("elb_client.modify_load_balancer_attributes(load_balancer_arn: #{load_balancer.load_balancer_arn}, attributes: #{attributes.inspect}) (dry-run)")
+              else
+                Hako.logger.info("elb_client.modify_load_balancer_attributes(load_balancer_arn: unknown, attributes: #{attributes.inspect}) (dry-run)")
+              end
             else
-              Hako.logger.info("elb_client.modify_load_balancer_attributes(load_balancer_arn: unknown, attributes: #{attributes.inspect}) (dry-run)")
+              Hako.logger.info("Updating ELBv2 attributes to #{attributes.inspect}")
+              elb_client.modify_load_balancer_attributes(load_balancer_arn: load_balancer.load_balancer_arn, attributes: attributes)
             end
-          else
-            Hako.logger.info("Updating ELBv2 attributes to #{attributes.inspect}")
-            elb_client.modify_load_balancer_attributes(load_balancer_arn: load_balancer.load_balancer_arn, attributes: attributes)
           end
         end
-        if @elb_v2_config.key?('target_group_attributes')
-          target_group = describe_target_group
-          attributes = @elb_v2_config.fetch('target_group_attributes').map { |key, value| { key: key, value: value } }
-          if @dry_run
-            if target_group
-              Hako.logger.info("elb_client.modify_target_group_attributes(target_group_arn: #{target_group.target_group_arn}, attributes: #{attributes.inspect}) (dry-run)")
+
+        unless target_group_given?
+          if @elb_v2_config.key?('target_group_attributes')
+            target_group = describe_target_group
+            attributes = @elb_v2_config.fetch('target_group_attributes').map { |key, value| { key: key, value: value } }
+            if @dry_run
+              if target_group
+                Hako.logger.info("elb_client.modify_target_group_attributes(target_group_arn: #{target_group.target_group_arn}, attributes: #{attributes.inspect}) (dry-run)")
+              else
+                Hako.logger.info("elb_client.modify_target_group_attributes(target_group_arn: unknown, attributes: #{attributes.inspect}) (dry-run)")
+              end
             else
-              Hako.logger.info("elb_client.modify_target_group_attributes(target_group_arn: unknown, attributes: #{attributes.inspect}) (dry-run)")
+              Hako.logger.info("Updating target group attributes to #{attributes.inspect}")
+              elb_client.modify_target_group_attributes(target_group_arn: target_group.target_group_arn, attributes: attributes)
             end
-          else
-            Hako.logger.info("Updating target group attributes to #{attributes.inspect}")
-            elb_client.modify_target_group_attributes(target_group_arn: target_group.target_group_arn, attributes: attributes)
           end
         end
         nil
@@ -194,39 +201,43 @@ module Hako
           return false
         end
 
-        load_balancer = describe_load_balancer
-        if load_balancer
-          if @dry_run
-            Hako.logger.info("elb_client.delete_load_balancer(load_balancer_arn: #{load_balancer.load_balancer_arn})")
+        unless load_balancer_given?
+          load_balancer = describe_load_balancer
+          if load_balancer
+            if @dry_run
+              Hako.logger.info("elb_client.delete_load_balancer(load_balancer_arn: #{load_balancer.load_balancer_arn})")
+            else
+              elb_client.delete_load_balancer(load_balancer_arn: load_balancer.load_balancer_arn)
+              Hako.logger.info "Deleted ELBv2 #{load_balancer.load_balancer_arn}"
+            end
           else
-            elb_client.delete_load_balancer(load_balancer_arn: load_balancer.load_balancer_arn)
-            Hako.logger.info "Deleted ELBv2 #{load_balancer.load_balancer_arn}"
+            Hako.logger.info "ELBv2 #{elb_name} doesn't exist"
           end
-        else
-          Hako.logger.info "ELBv2 #{elb_name} doesn't exist"
         end
 
-        target_group = describe_target_group
-        if target_group
-          if @dry_run
-            Hako.logger.info("elb_client.delete_target_group(target_group_arn: #{target_group.target_group_arn})")
-          else
-            deleted = false
-            30.times do
-              begin
-                elb_client.delete_target_group(target_group_arn: target_group.target_group_arn)
-                deleted = true
-                break
-              rescue Aws::ElasticLoadBalancingV2::Errors::ResourceInUse => e
-                Hako.logger.warn("#{e.class}: #{e.message}")
+        unless target_group_given?
+          target_group = describe_target_group
+          if target_group
+            if @dry_run
+              Hako.logger.info("elb_client.delete_target_group(target_group_arn: #{target_group.target_group_arn})")
+            else
+              deleted = false
+              30.times do
+                begin
+                  elb_client.delete_target_group(target_group_arn: target_group.target_group_arn)
+                  deleted = true
+                  break
+                rescue Aws::ElasticLoadBalancingV2::Errors::ResourceInUse => e
+                  Hako.logger.warn("#{e.class}: #{e.message}")
+                end
+                sleep 1
+              end
+              unless deleted
+                raise Error.new("Cannot delete target group #{target_group.target_group_arn}")
               end
-              sleep 1
-            end
-            unless deleted
-              raise Error.new("Cannot delete target group #{target_group.target_group_arn}")
-            end
 
-            Hako.logger.info "Deleted target group #{target_group.target_group_arn}"
+              Hako.logger.info "Deleted target group #{target_group.target_group_arn}"
+            end
           end
         end
       end
@@ -236,9 +247,19 @@ module Hako
         @elb_v2_config.fetch('load_balancer_name', "hako-#{@app_id}")
       end
 
+      # @return [Boolean]
+      def load_balancer_given?
+        @elb_v2_config.key?('load_balancer_name')
+      end
+
       # @return [String]
       def target_group_name
-        @elb_v2_config.fetch('target_group_name', elb_name)
+        @elb_v2_config.fetch('target_group_name', "hako-#{@app_id}")
+      end
+
+      # @return [Boolean]
+      def target_group_given?
+        @elb_v2_config.key?('target_group_name')
       end
 
       # @return [Hash]

data/lib/hako/script.rb

@@ -44,6 +44,8 @@ module Hako
     # @param [Hash<String, Container>] _containers
     def oneshot_finished(_containers); end
 
+    def remove_starting; end
+
     def after_remove; end
 
     private

data/lib/hako/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hako
-  VERSION = '2.8.0'
+  VERSION = '2.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hako
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-applicationautoscaling
@@ -327,6 +327,7 @@ files:
 - examples/hello-nofront.jsonnet
 - examples/hello-privileged-app.jsonnet
 - examples/hello-service-discovery.jsonnet
+- examples/hello-shared-alb.jsonnet
 - examples/hello.env
 - examples/hello.jsonnet
 - examples/put-ecs-container-status-to-s3/index.js