kubernetes-deploy 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eed75bcad069720e6c7c9d44555af98924edca18
-  data.tar.gz: 0f83407244b6b0f63ebceb7dffe92dccefa44f3b
+  metadata.gz: 255ea8b3ecd484e3867da8b34b4a61a927d99c1f
+  data.tar.gz: 79c4034b3460995f65fbeb54216688a5b1f448b6
 SHA512:
-  metadata.gz: a13bc984fae5dd38639ab6ad8c0a4c3d69b6dd776f117ede5b47f05fa80199e59c8da0d6be6b35ca43455e8d1a9e4dd839932ca3f7db12983c247d940e4e9220
-  data.tar.gz: 2412db53a8791bad8debfdf5bae2cfde075e49bbb725995fd972ce49b6936469db5281bb95befba25885e06cd45819002eb27af16237934d554494fac54ba4d2
+  metadata.gz: 8c9b9c54dea86318add19d23123e00ec5f3195488ec0ecbf954cdfe126dd1ca780d2c7cea6687342f2df8410ef7c5a53fd8b3ebb0649b6e8488fb1f2be42f0ef
+  data.tar.gz: a2cc7698a3b9f9b66bf8a54b7c5ac2483946760cdb52612c8b73fbc3c57ad8f716e8cedb4e1a732ecda59a82f37815de4ba41eb212a1e75399bd461b06061ebc

data/.rubocop.yml

@@ -3,3 +3,6 @@ inherit_from:
 
 AllCops:
   TargetRubyVersion: 2.1
+
+Layout/IndentHeredoc:
+  EnforcedStyle: active_support

data/README.md

@@ -123,7 +123,13 @@ To run the tests:
 * Make sure you have a context named "minikube" in your kubeconfig. Minikube adds this context for you when you run `minikube start`; please do not rename it. You can check for it using `kubectl config get-contexts`.
 * Run `bundle exec rake test`
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version:
+
+* Update the version number in `version.rb`
+* Tag the version with `git tag vx.y.z && git push --tags`
+* A Shopify employee can use the [Shipit Stack](https://shipit.shopify.io/shopify/kubernetes-deploy/rubygems) to build the `.gem` file and upload to [rubygems.org](https://rubygems.org/gems/kubernetes-deploy).
 
 ## CI
 

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/exe/kubernetes-deploy

@@ -15,7 +15,7 @@ verbose_log_prefix = false
 ARGV.options do |opts|
   opts.on("--bindings=BINDINGS", Array, "k1=v1,k2=v2") do |binds|
     bindings = binds.each_with_object({}) do |bind, acc|
-      k,v = bind.split('=')
+      k, v = bind.split('=')
       raise "key for value #{v} is blank!" if k.blank?
       raise "value for key #{k} is blank!" if v.blank?
       acc[k] = v

data/exe/kubernetes-run

@@ -11,7 +11,7 @@ env_vars = []
 
 ARGV.options do |opts|
   opts.on("--template=TEMPLATE") { |n| template = n }
-  opts.on("--env-vars=ENV_VARS") { |vars| env_vars = n.split(",")}
+  opts.on("--env-vars=ENV_VARS") { |vars| env_vars = vars.split(",") }
   opts.on("--entrypoint=ENTRYPOINT") { |c| entrypoint = [c] }
   opts.parse!
 end

data/kubernetes-deploy.gemspec

@@ -6,10 +6,10 @@ require 'kubernetes-deploy/version'
 Gem::Specification.new do |spec|
   spec.name          = "kubernetes-deploy"
   spec.version       = KubernetesDeploy::VERSION
-  spec.authors       = ["Kir Shatrov", "Jean Boussier", "Katrina Verey"]
+  spec.authors       = ["Katrina Verey", "Kir Shatrov"]
   spec.email         = ["ops-accounts+shipit@shopify.com"]
 
-  spec.summary       = %q{Kubernetes deploy scripts}
+  spec.summary       = 'Kubernetes deploy scripts'
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/Shopify/kubernetes-deploy"
   spec.license       = "MIT"

data/lib/kubernetes-deploy.rb

@@ -1,4 +1,6 @@
+# rubocop:disable Style/FileName
 # frozen_string_literal: true
+
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/slice'
 require 'active_support/core_ext/numeric/time'

data/lib/kubernetes-deploy/deferred_summary_logging.rb

@@ -23,12 +23,12 @@ module KubernetesDeploy
       heading("Phase #{@current_phase}: #{phase_name}")
     end
 
-    def heading(text, secondary_msg = '', secondary_msg_color = :light_blue)
+    def heading(text, secondary_msg = '', secondary_msg_color = :cyan)
       padding = (100.0 - (text.length + secondary_msg.length)) / 2
       blank_line
-      part1 = ColorizedString.new("#{'-' * padding.floor}#{text}").light_blue
+      part1 = ColorizedString.new("#{'-' * padding.floor}#{text}").cyan
       part2 = ColorizedString.new(secondary_msg).colorize(secondary_msg_color)
-      part3 = ColorizedString.new('-' * padding.ceil).light_blue
+      part3 = ColorizedString.new('-' * padding.ceil).cyan
       info(part1 + part2 + part3)
     end
 

data/lib/kubernetes-deploy/kubernetes_resource.rb

@@ -10,6 +10,7 @@ module KubernetesDeploy
     attr_writer :type, :deploy_started
 
     TIMEOUT = 5.minutes
+    LOG_LINE_COUNT = 250
 
     DEBUG_RESOURCE_NOT_FOUND_MESSAGE = "None found. Please check your usual logging service (e.g. Splunk)."
     UNUSUAL_FAILURE_MESSAGE = <<-MSG.strip_heredoc
@@ -138,7 +139,7 @@ module KubernetesDeploy
         if container_logs.blank? || container_logs.values.all?(&:blank?)
           helpful_info << "  - Logs: #{DEBUG_RESOURCE_NOT_FOUND_MESSAGE}"
         else
-          helpful_info << "  - Logs:"
+          helpful_info << "  - Logs (last #{LOG_LINE_COUNT} lines shown):"
           container_logs.each do |identifier, logs|
             logs.split("\n").each do |line|
               helpful_info << "      [#{identifier}]\t#{line}"

data/lib/kubernetes-deploy/kubernetes_resource/pod.rb

@@ -75,12 +75,14 @@ module KubernetesDeploy
       return {} unless exists? && @containers.present?
 
       @containers.each_with_object({}) do |container_name, container_logs|
-        out, _err, _st = kubectl.run(
+        cmd = [
           "logs",
           @name,
           "--container=#{container_name}",
-          "--since-time=#{@deploy_started.to_datetime.rfc3339}"
-        )
+          "--since-time=#{@deploy_started.to_datetime.rfc3339}",
+        ]
+        cmd << "--tail=#{LOG_LINE_COUNT}" unless unmanaged?
+        out, _err, _st = kubectl.run(*cmd)
         container_logs["#{id}/#{container_name}"] = out
       end
     end

data/lib/kubernetes-deploy/resource_watcher.rb

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 module KubernetesDeploy
   class ResourceWatcher
-    def initialize(resources, logger:)
+    def initialize(resources, logger:, deploy_started_at: Time.now.utc)
       unless resources.is_a?(Enumerable)
-        raise ArgumentError, <<-MSG.strip
-ResourceWatcher expects Enumerable collection, got `#{resources.class}` instead
-MSG
+        raise ArgumentError, <<-MSG.strip_heredoc
+          ResourceWatcher expects Enumerable collection, got `#{resources.class}` instead
+        MSG
       end
       @resources = resources
       @logger = logger
+      @deploy_started_at = deploy_started_at
     end
 
     def run(delay_sync: 3.seconds)
       delay_sync_until = Time.now.utc
-      started_at = delay_sync_until
 
       while @resources.present?
         if Time.now.utc < delay_sync_until
           sleep(delay_sync_until - Time.now.utc)
         end
-        watch_time = (Time.now.utc - started_at).round(1)
+        watch_time = (Time.now.utc - @deploy_started_at).round(1)
         delay_sync_until = Time.now.utc + delay_sync # don't pummel the API if the sync is fast
         @resources.each(&:sync)
         newly_finished_resources, @resources = @resources.partition(&:deploy_finished?)

data/lib/kubernetes-deploy/runner.rb

@@ -111,21 +111,20 @@ module KubernetesDeploy
         raise FatalDeploymentError, "Refusing to deploy to protected namespace '#{@namespace}' with pruning enabled"
       end
 
-      deploy_resources(resources, prune: prune)
-
-      unless verify_result
+      if verify_result
+        deploy_resources(resources, prune: prune, verify: true)
+        record_statuses(resources)
+        success = resources.all?(&:deploy_succeeded?)
+      else
+        deploy_resources(resources, prune: prune, verify: false)
         @logger.summary.add_action("deployed #{resources.length} #{'resource'.pluralize(resources.length)}")
         warning = <<-MSG.strip_heredoc
           Deploy result verification is disabled for this deploy.
           This means the desired changes were communicated to Kubernetes, but the deploy did not make sure they actually succeeded.
         MSG
         @logger.summary.add_paragraph(ColorizedString.new(warning).yellow)
-        return success = true
+        success = true
       end
-
-      wait_for_completion(resources)
-      record_statuses(resources)
-      success = resources.all?(&:deploy_succeeded?)
     rescue FatalDeploymentError => error
       @logger.summary.add_action(error.message)
       success = false
@@ -200,8 +199,7 @@ module KubernetesDeploy
       PREDEPLOY_SEQUENCE.each do |resource_type|
         matching_resources = resource_list.select { |r| r.type == resource_type }
         next if matching_resources.empty?
-        deploy_resources(matching_resources)
-        wait_for_completion(matching_resources)
+        deploy_resources(matching_resources, verify: true)
 
         failed_resources = matching_resources.reject(&:deploy_succeeded?)
         fail_count = failed_resources.length
@@ -297,8 +295,8 @@ module KubernetesDeploy
       @logger.summary.add_paragraph(debug_msg)
     end
 
-    def wait_for_completion(watched_resources)
-      watcher = ResourceWatcher.new(watched_resources, logger: @logger)
+    def wait_for_completion(watched_resources, started_at)
+      watcher = ResourceWatcher.new(watched_resources, logger: @logger, deploy_started_at: started_at)
       watcher.run
     end
 
@@ -359,37 +357,46 @@ module KubernetesDeploy
       @logger.info("All required parameters and files are present")
     end
 
-    def deploy_resources(resources, prune: false)
-      @logger.info("Deploying resources:")
+    def deploy_resources(resources, prune: false, verify:)
+      return if resources.empty?
+      deploy_started_at = Time.now.utc
+
+      if resources.length > 1
+        @logger.info("Deploying resources:")
+      else
+        resource = resources.first
+        @logger.info("Deploying #{resource.id} (timeout: #{resource.timeout}s)")
+      end
 
       # Apply can be done in one large batch, the rest have to be done individually
       applyables, individuals = resources.partition { |r| r.deploy_method == :apply }
 
       individuals.each do |r|
-        @logger.info("- #{r.id}")
+        @logger.info("- #{r.id} (timeout: #{r.timeout}s)") if resources.length > 1
         r.deploy_started = Time.now.utc
         case r.deploy_method
         when :replace
-          _, _, st = kubectl.run("replace", "-f", r.file.path, log_failure: false)
+          _, _, replace_st = kubectl.run("replace", "-f", r.file.path, log_failure: false)
         when :replace_force
-          _, _, st = kubectl.run("replace", "--force", "-f", r.file.path, log_failure: false)
+          _, _, replace_st = kubectl.run("replace", "--force", "-f", r.file.path, log_failure: false)
         else
           # Fail Fast! This is a programmer mistake.
           raise ArgumentError, "Unexpected deploy method! (#{r.deploy_method.inspect})"
         end
 
-        next if st.success?
+        next if replace_st.success?
         # it doesn't exist so we can't replace it
-        _, err, st = kubectl.run("create", "-f", r.file.path, log_failure: false)
-        unless st.success?
-          raise FatalDeploymentError, <<-MSG.strip_heredoc
-            Failed to replace or create resource: #{r.id}
-            #{err}
-          MSG
-        end
+        _, err, create_st = kubectl.run("create", "-f", r.file.path, log_failure: false)
+
+        next if create_st.success?
+        raise FatalDeploymentError, <<-MSG.strip_heredoc
+          Failed to replace or create resource: #{r.id}
+          #{err}
+        MSG
       end
 
       apply_all(applyables, prune)
+      wait_for_completion(resources, deploy_started_at) if verify
     end
 
     def apply_all(resources, prune)
@@ -397,7 +404,7 @@ module KubernetesDeploy
 
       command = ["apply"]
       resources.each do |r|
-        @logger.info("- #{r.id} (timeout: #{r.timeout}s)")
+        @logger.info("- #{r.id} (timeout: #{r.timeout}s)") if resources.length > 1
         command.push("-f", r.file.path)
         r.deploy_started = Time.now.utc
       end

data/lib/kubernetes-deploy/runner_task.rb

@@ -68,11 +68,8 @@ module KubernetesDeploy
       begin
         @kubeclient.get_namespace(@namespace) if @namespace.present?
       rescue KubeException => e
-        errors << if e.error_code == 404
-          "Namespace was not found"
-        else
-          "Could not connect to kubernetes cluster"
-        end
+        msg = e.error_code == 404 ? "Namespace was not found" : "Could not connect to kubernetes cluster"
+        errors << msg
       end
 
       raise FatalTaskRunError, "Configuration invalid: #{errors.join(', ')}" unless errors.empty?

data/lib/kubernetes-deploy/version.rb

@@ -1,3 +1,3 @@
 module KubernetesDeploy
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-deploy
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
-- Kir Shatrov
-- Jean Boussier
 - Katrina Verey
+- Kir Shatrov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport