kubernetes-deploy 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 820602ac9a434949fb86a0f1cb85996962d4ecb2
-  data.tar.gz: 492b43ccf6a0683b93cc3b187c6711e9bdb176b1
+  metadata.gz: 99f56eb5da1d7f17885cff3d19787b45a1484504
+  data.tar.gz: e2919b899b313e2c4be0af2b7731816f9c8336de
 SHA512:
-  metadata.gz: 23706dd66b3844c4b6fece858621bf4b9cea5c0c65568b972cb6afdfab64a1f8d45957c7095a3ca8af96f9c488f383f2f1fd69d99d5affdbf9545d9c0c7ac948
-  data.tar.gz: 64bf0d15a51c97be05e80a3b64b0e3f985f0f6a0bd137fbd1e6353b13bec404e6dd150a66f34c15f0f24cfee66a1838efba2d6260bf6ece9bf5c4c0903e55e12
+  metadata.gz: 103546e46a2e476e1cc1ae339fcce8362fd199d144d890d1b895ed46848181ba822dcb713eb672581f625b25e3992c4ea9439e59888c4b3f0b74b44d156bba50
+  data.tar.gz: 7aeb474292e52f2b3e9ead4f038732804949c253da2119993c89d64e1357d7920c2031bce184821cb711c091ed54f8b6edf181c47d72b9242c3d2e0c972d7355

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 0.19.0
+*Features*
+- Added `--max-watch-seconds=seconds` to kubernetes-restart and kubernetes-deploy. When set
+a timeout error is raised if it takes longer than _seconds_ for any resource to deploy.
+- Adds YAML and JSON file reference support to the kubernetes-deploy `--bindings` argument ([#269](https://github.com/Shopify/kubernetes-deploy/pull/269))
+
+*Enhancements*
+- Prune resource quotas ([#264](https://github.com/Shopify/kubernetes-deploy/pull/264/files))
+
+*Bug Fixes*
+- Update gemspec to reflect need for ActiveSupport >= 5.0([#270](https://github.com/Shopify/kubernetes-deploy/pull/270))
+
 ### 0.18.1
 *Enhancements*
 - Change the way the resource watcher fetches resources to make it more efficient for large deploys. Deploys with hundreds of resources are expected to see a measurable performance improvement from this change. ([#251](https://github.com/Shopify/kubernetes-deploy/pull/251))

data/README.md

@@ -107,9 +107,8 @@ Refer to `kubernetes-deploy --help` for the authoritative set of options.
 - `--template-dir=DIR`: Used to set the deploy directory. Set `$ENVIRONMENT` instead to use `config/deploy/$ENVIRONMENT`.
 - `--bindings=BINDINGS`: Makes additional variables available to your ERB templates. For example, `kubernetes-deploy my-app cluster1 --bindings=color=blue,size=large` will expose `color` and `size`.
 - `--no-prune`: Skips pruning of resources that are no longer in your Kubernetes template set. Not recommended, as it allows your namespace to accumulate cruft that is not reflected in your deploy directory.
-
-
-
+- `--max-watch-seconds=seconds`: Raise a timeout error if it takes longer than _seconds_ for any
+resource to deploy.
 
 
 ### Using templates and variables
@@ -121,7 +120,24 @@ All templates must be YAML formatted. You can also use ERB. The following local
 * `current_sha`: The value of `$REVISION`
 * `deployment_id`:  A randomly generated identifier for the deploy. Useful for creating unique names for task-runner pods (e.g. a pod that runs rails migrations at the beginning of deploys).
 
-You can add additional variables using the `--bindings=BINDINGS` option which can be formated as comma separated or as JSON. For example, `kubernetes-deploy my-app cluster1 --bindings=color=blue,size=large` or `kubernetes-deploy my-app cluster1 --bindings='{"color":"blue","size":"large"}'` will expose `color` and `size` in your templates. Complex JSON data will be converted to a Hash for use in templates.
+You can add additional variables using the `--bindings=BINDINGS` option which can be formated as comma separated string, JSON string or path to a JSON or YAML file. Complex JSON or YAML data will be converted to a Hash for use in templates. To load a file the argument should include the relative file path prefixed with an `@` sign. An argument error will be raised if the string argument cannot be parsed, the referenced file does not include a valid extension (`.json`, `.yaml` or `.yml`) or the referenced file does not exist.
+
+#### Bindings examples
+
+```
+# Comma separated string. Exposes, 'color' and 'size'
+$ kubernetes-deploy my-app cluster1 --bindings=color=blue,size=large
+
+# JSON string. Exposes, 'color' and 'size'
+$ kubernetes-deploy my-app cluster1 --bindings='{"color":"blue","size":"large"}'
+
+# Load JSON file from ./config
+$ kubernetes-deploy my-app cluster1 --bindings='@config/production.json'
+
+# Load YAML file from ./config (.yaml or .yml supported)
+$ kubernetes-deploy my-app cluster1 --bindings='@config/production.yaml'
+```
+
 
 #### Using partials
 

data/exe/kubernetes-deploy

@@ -10,10 +10,11 @@ allow_protected_ns = false
 prune = true
 bindings = {}
 verbose_log_prefix = false
+max_watch_seconds = nil
 
 ARGV.options do |opts|
   opts.on("--bindings=BINDINGS", "Expose additional variables to ERB templates " \
-    "(format: k1=v1,k2=v2 or JSON)") do |binds|
+    "(format: k1=v1,k2=v2, JSON string or file (JSON or YAML) path prefixed by '@')") do |binds|
     bindings = KubernetesDeploy::BindingsParser.parse(binds)
   end
 
@@ -23,6 +24,10 @@ ARGV.options do |opts|
   opts.on("--no-prune", "Disable deletion of resources that do not appear in the template dir") { prune = false }
   opts.on("--template-dir=DIR", "Set the template dir (default: config/deploy/$ENVIRONMENT)") { |v| template_dir = v }
   opts.on("--verbose-log-prefix", "Add [context][namespace] to the log prefix") { verbose_log_prefix = true }
+  opts.on("--max-watch-seconds=seconds",
+    "Timeout error is raised if it takes longer than the specified number of seconds") do |t|
+    max_watch_seconds = t.to_i
+  end
 
   opts.on_tail("-h", "--help", "Print this help") do
     puts opts
@@ -60,7 +65,8 @@ runner = KubernetesDeploy::DeployTask.new(
   current_sha: revision,
   template_dir: template_dir,
   bindings: bindings,
-  logger: logger
+  logger: logger,
+  max_watch_seconds: max_watch_seconds
 )
 
 begin

data/exe/kubernetes-restart

@@ -7,8 +7,10 @@ require 'kubernetes-deploy'
 require 'kubernetes-deploy/restart_task'
 
 raw_deployments = nil
+max_watch_seconds = nil
 ARGV.options do |opts|
   opts.on("--deployments=LIST") { |v| raw_deployments = v.split(",") }
+  opts.on("--max-watch-seconds=seconds") { |t| max_watch_seconds = t.to_i }
   opts.parse!
 end
 
@@ -16,7 +18,8 @@ namespace = ARGV[0]
 context = ARGV[1]
 logger = KubernetesDeploy::FormattedLogger.build(namespace, context)
 
-restart = KubernetesDeploy::RestartTask.new(namespace: namespace, context: context, logger: logger)
+restart = KubernetesDeploy::RestartTask.new(namespace: namespace, context: context, logger: logger,
+   max_watch_seconds: max_watch_seconds)
 begin
   restart.perform!(raw_deployments)
 rescue KubernetesDeploy::DeploymentTimeoutError

data/kubernetes-deploy.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.3.0'
-  spec.add_dependency "activesupport", ">= 4.2"
+  spec.add_dependency "activesupport", ">= 5.0"
   spec.add_dependency "kubeclient", "~> 2.4"
   spec.add_dependency "rest-client", ">= 1.7" # Minimum required by kubeclient. Remove when kubeclient releases v3.0.
   spec.add_dependency "googleauth", ">= 0.5"

data/lib/kubernetes-deploy/bindings_parser.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'json'
+require 'yaml'
 require 'csv'
 
 module KubernetesDeploy
@@ -7,7 +8,7 @@ module KubernetesDeploy
     extend self
 
     def parse(string)
-      bindings = parse_json(string) || parse_csv(string)
+      bindings = parse_file(string) || parse_json(string) || parse_csv(string)
 
       unless bindings
         raise ArgumentError, "Failed to parse bindings."
@@ -18,6 +19,27 @@ module KubernetesDeploy
 
     private
 
+    def parse_file(string)
+      return unless string =~ /\A@/
+
+      begin
+        file_path = string.gsub(/\A@/, '')
+
+        case File.extname(file_path)
+        when '.json'
+          bindings = parse_json(File.read(file_path))
+        when '.yaml', '.yml'
+          bindings = YAML.load(File.read(file_path))
+        else
+          raise ArgumentError, "Supplied file does not appear to be JSON or YAML"
+        end
+
+        bindings
+      rescue Errno::ENOENT
+        raise ArgumentError, "Supplied file does not exist: #{string}"
+      end
+    end
+
     def parse_json(string)
       bindings = JSON.parse(string)
 

data/lib/kubernetes-deploy/deploy_task.rb

@@ -68,6 +68,7 @@ module KubernetesDeploy
         core/v1/ConfigMap
         core/v1/Pod
         core/v1/Service
+        core/v1/ResourceQuota
         batch/v1/Job
         extensions/v1beta1/DaemonSet
         extensions/v1beta1/Deployment
@@ -88,13 +89,15 @@ module KubernetesDeploy
 
     NOT_FOUND_ERROR = 'NotFound'
 
-    def initialize(namespace:, context:, current_sha:, template_dir:, logger:, kubectl_instance: nil, bindings: {})
+    def initialize(namespace:, context:, current_sha:, template_dir:, logger:, kubectl_instance: nil, bindings: {},
+      max_watch_seconds: nil)
       @namespace = namespace
       @context = context
       @current_sha = current_sha
       @template_dir = File.expand_path(template_dir)
       @logger = logger
       @kubectl = kubectl_instance
+      @max_watch_seconds = max_watch_seconds
       @renderer = KubernetesDeploy::Renderer.new(
         current_sha: @current_sha,
         template_dir: @template_dir,
@@ -376,7 +379,7 @@ module KubernetesDeploy
 
       if verify
         watcher = ResourceWatcher.new(resources: resources, sync_mediator: @sync_mediator,
-          logger: @logger, deploy_started_at: deploy_started_at)
+          logger: @logger, deploy_started_at: deploy_started_at, timeout: @max_watch_seconds)
         watcher.run(record_summary: record_summary)
       end
     end

data/lib/kubernetes-deploy/kubernetes_resource.rb

@@ -158,9 +158,13 @@ module KubernetesDeploy
       @debug_info_synced = true
     end
 
-    def debug_message
+    def debug_message(cause = nil, info_hash = {})
       helpful_info = []
-      if deploy_failed?
+      if cause == :gave_up
+        helpful_info << ColorizedString.new("#{id}: GLOBAL WATCH TIMEOUT (#{info_hash[:timeout]} seconds)").yellow
+        helpful_info << "If you expected it to take longer than #{info_hash[:timeout]} seconds for your deploy"\
+        " to roll out, increase --max-watch-seconds."
+      elsif deploy_failed?
         helpful_info << ColorizedString.new("#{id}: FAILED").red
         helpful_info << failure_message if failure_message.present?
       elsif deploy_timed_out?

data/lib/kubernetes-deploy/resource_watcher.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 module KubernetesDeploy
   class ResourceWatcher
-    def initialize(resources:, sync_mediator:, logger:, deploy_started_at: Time.now.utc, operation_name: "deploy")
+    def initialize(resources:, sync_mediator:, logger:, deploy_started_at: Time.now.utc,
+      operation_name: "deploy", timeout: nil)
       unless resources.is_a?(Enumerable)
         raise ArgumentError, <<~MSG
           ResourceWatcher expects Enumerable collection, got `#{resources.class}` instead
@@ -12,13 +13,17 @@ module KubernetesDeploy
       @sync_mediator = sync_mediator
       @deploy_started_at = deploy_started_at
       @operation_name = operation_name
+      @timeout = timeout
     end
 
     def run(delay_sync: 3.seconds, reminder_interval: 30.seconds, record_summary: true)
-      delay_sync_until = last_message_logged_at = Time.now.utc
+      delay_sync_until = last_message_logged_at = monitoring_started = Time.now.utc
       remainder = @resources.dup
 
       while remainder.present?
+        if @timeout && (Time.now.utc - monitoring_started > @timeout)
+          report_and_give_up(remainder)
+        end
         if Time.now.utc < delay_sync_until
           sleep(delay_sync_until - Time.now.utc)
         end
@@ -69,20 +74,30 @@ module KubernetesDeploy
       @logger.info(msg)
     end
 
+    def report_and_give_up(remaining_resources)
+      successful_resources, failed_resources = (@resources - remaining_resources).partition(&:deploy_succeeded?)
+      record_success_statuses(successful_resources)
+      record_failed_statuses(failed_resources, remaining_resources)
+
+      if failed_resources.present? && !failed_resources.all?(&:deploy_timed_out?)
+        raise FatalDeploymentError
+      else
+        raise DeploymentTimeoutError
+      end
+    end
+
     def record_statuses_for_summary(resources)
       successful_resources, failed_resources = resources.partition(&:deploy_succeeded?)
-      fail_count = failed_resources.length
-      success_count = successful_resources.length
+      record_success_statuses(successful_resources)
+      record_failed_statuses(failed_resources)
+    end
 
-      if success_count > 0
-        @logger.summary.add_action("successfully #{@operation_name}ed #{success_count} "\
-          "#{'resource'.pluralize(success_count)}")
-        final_statuses = successful_resources.map(&:pretty_status).join("\n")
-        @logger.summary.add_paragraph("#{ColorizedString.new('Successful resources').green}\n#{final_statuses}")
-      end
+    def record_failed_statuses(failed_resources, global_timeouts = [])
+      fail_count = failed_resources.length + global_timeouts.length
 
       if fail_count > 0
         timeouts, failures = failed_resources.partition(&:deploy_timed_out?)
+        timeouts += global_timeouts
         if timeouts.present?
           @logger.summary.add_action(
             "timed out waiting for #{timeouts.length} #{'resource'.pluralize(timeouts.length)} to #{@operation_name}"
@@ -94,10 +109,21 @@ module KubernetesDeploy
             "failed to #{@operation_name} #{failures.length} #{'resource'.pluralize(failures.length)}"
           )
         end
-        KubernetesDeploy::Concurrency.split_across_threads(failed_resources) do |r|
+        KubernetesDeploy::Concurrency.split_across_threads(failed_resources + global_timeouts) do |r|
           r.sync_debug_info(@sync_mediator.kubectl)
         end
         failed_resources.each { |r| @logger.summary.add_paragraph(r.debug_message) }
+        global_timeouts.each { |r| @logger.summary.add_paragraph(r.debug_message(:gave_up, timeout: @timeout)) }
+      end
+    end
+
+    def record_success_statuses(successful_resources)
+      success_count = successful_resources.length
+      if success_count > 0
+        @logger.summary.add_action("successfully #{@operation_name}ed #{success_count} "\
+          "#{'resource'.pluralize(success_count)}")
+        final_statuses = successful_resources.map(&:pretty_status).join("\n")
+        @logger.summary.add_paragraph("#{ColorizedString.new('Successful resources').green}\n#{final_statuses}")
       end
     end
 

data/lib/kubernetes-deploy/restart_task.rb

@@ -20,11 +20,12 @@ module KubernetesDeploy
     HTTP_OK_RANGE = 200..299
     ANNOTATION = "shipit.shopify.io/restart"
 
-    def initialize(context:, namespace:, logger:)
+    def initialize(context:, namespace:, logger:, max_watch_seconds: nil)
       @context = context
       @namespace = namespace
       @logger = logger
       @sync_mediator = SyncMediator.new(namespace: @namespace, context: @context, logger: @logger)
+      @max_watch_seconds = max_watch_seconds
     end
 
     def perform(*args)
@@ -50,7 +51,7 @@ module KubernetesDeploy
       @logger.phase_heading("Waiting for rollout")
       resources = build_watchables(deployments, start)
       ResourceWatcher.new(resources: resources, sync_mediator: @sync_mediator,
-        logger: @logger, operation_name: "restart").run
+        logger: @logger, operation_name: "restart", timeout: @max_watch_seconds).run
       failed_resources = resources.reject(&:deploy_succeeded?)
       success = failed_resources.empty?
       if !success && failed_resources.all?(&:deploy_timed_out?)

data/lib/kubernetes-deploy/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module KubernetesDeploy
-  VERSION = "0.18.1"
+  VERSION = "0.19.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-deploy
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Katrina Verey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: kubeclient
   requirement: !ruby/object:Gem::Requirement