kubernetes-deploy 0.15.1 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47534a160d32999369931589fe698e7befe31d12
-  data.tar.gz: 7cf8a851a0d0bcfb6d914358d0a973fa3296e875
+  metadata.gz: c48f0cc4be05113a752768e19118a03d26c3505a
+  data.tar.gz: 2d51f6e48f927cbbf44a277e600bd728f09a1025
 SHA512:
-  metadata.gz: f0f6e54b90c9774f0e5b2b5f4d286c8bcd407e4547fc8555c2068b710718a66fc87dcf3f859c597f4ddbab9f38cb5390f00cf8b40837857661340c73e4631ae3
-  data.tar.gz: 3f55e5cbfcef2022c50d15394af1e52678252aca7195ff924d89a4cd444978e793283f63e426c849b6c17d3a571aed09f13bb010302833844c3bdb99aa7519e9
+  metadata.gz: d87392236bf5d4ceea11ad27ede7248abc611869b983f4eff8ecf8c43c4d09dc6164f36c5ce1ef7efa6022eaddee3791898e2f4b09e113ea63dc9c89b47ccd8a
+  data.tar.gz: f31edab5e0c2afd6e89cc81df85dba6e271040ffb932a83e79117da109b7353b95e17dbfe36c158d6a37ea42bc245a13af7eda92c3cd882c1766bc32c9619950

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.15.2
+*Enhancements*
+- Print warnings if kubernetes server version is not supported ([#237](https://github.com/Shopify/kubernetes-deploy/pull/237)).
+- Possible via env var to disable fetching logs and/or events on deployment failure ([#239](https://github.com/Shopify/kubernetes-deploy/pull/239)).
+- The `kubernetes-deploy.shopify.io/required-rollout` annotation now takes a percent (e.g. 90%) ([#240](https://github.com/Shopify/kubernetes-deploy/pull/240)).
+
 ### 0.15.1
 *Enhancements*
 - Fetch debug events and logs for failed resources in parallel ([#238](https://github.com/Shopify/kubernetes-deploy/pull/238))

data/README.md

@@ -134,6 +134,8 @@ before the deployment is considered successful.
   In other words, the number of new pods that must be ready is equal to `spec.replicas` - `strategy.RollingUpdate.maxUnavailable`
   (converted from percentages by rounding up, if applicable). This option is only valid for deployments
   that use the `RollingUpdate` strategy.
+  - Percent (e.g. 90%): The deploy is successful when the number of new pods that are ready is equal to
+  `spec.replicas` * Percent.
 
 
 ### Running tasks at the beginning of a deploy

data/lib/kubernetes-deploy.rb

@@ -21,5 +21,6 @@ require 'kubernetes-deploy/bindings_parser'
 require 'kubernetes-deploy/duration_parser'
 
 module KubernetesDeploy
+  MIN_KUBE_VERSION = '1.6.0'
   KubernetesDeploy::StatsD.build
 end

data/lib/kubernetes-deploy/deploy_task.rb

@@ -441,6 +441,9 @@ module KubernetesDeploy
         end
       end
       raise FatalDeploymentError, "Failed to reach server for #{@context}" unless success
+      if kubectl.server_version < Gem::Version.new(MIN_KUBE_VERSION)
+        @logger.warn(KubernetesDeploy::Errors.server_version_warning(server_version))
+      end
     end
 
     def confirm_namespace_exists

data/lib/kubernetes-deploy/errors.rb

@@ -8,4 +8,11 @@ module KubernetesDeploy
       super("Namespace `#{name}` not found in context `#{context}`")
     end
   end
+  module Errors
+    extend self
+    def server_version_warning(server_version)
+      "Minimum cluster version requirement of #{MIN_KUBE_VERSION} not met. "\
+      "Using #{server_version} could result in unexpected behavior as it is no longer tested against"
+    end
+  end
 end

data/lib/kubernetes-deploy/kubernetes_resource.rb

@@ -12,6 +12,10 @@ module KubernetesDeploy
     TIMEOUT = 5.minutes
     LOG_LINE_COUNT = 250
 
+    DISABLE_FETCHING_LOG_INFO = 'DISABLE_FETCHING_LOG_INFO'
+    DISABLE_FETCHING_EVENT_INFO = 'DISABLE_FETCHING_EVENT_INFO'
+    DISABLED_LOG_INFO_MESSAGE = "collection is disabled by the #{DISABLE_FETCHING_LOG_INFO} env var."
+    DISABLED_EVENT_INFO_MESSAGE = "collection is disabled by the #{DISABLE_FETCHING_EVENT_INFO} env var."
     DEBUG_RESOURCE_NOT_FOUND_MESSAGE = "None found. Please check your usual logging service (e.g. Splunk)."
     UNUSUAL_FAILURE_MESSAGE = <<~MSG
       It is very unusual for this resource type to fail to deploy. Please try the deploy again.
@@ -141,8 +145,8 @@ module KubernetesDeploy
     end
 
     def sync_debug_info
-      @events = fetch_events
-      @logs = fetch_logs if supports_logs?
+      @events = fetch_events unless ENV[DISABLE_FETCHING_EVENT_INFO]
+      @logs = fetch_logs if supports_logs? && !ENV[DISABLE_FETCHING_EVENT_INFO]
       @debug_info_synced = true
     end
 
@@ -169,12 +173,16 @@ module KubernetesDeploy
         @events.each do |identifier, event_hashes|
           event_hashes.each { |event| helpful_info << "      [#{identifier}]\t#{event}" }
         end
+      elsif ENV[DISABLE_FETCHING_EVENT_INFO]
+        helpful_info << "  - Events: #{DISABLED_EVENT_INFO_MESSAGE}"
       else
         helpful_info << "  - Events: #{DEBUG_RESOURCE_NOT_FOUND_MESSAGE}"
       end
 
       if supports_logs?
-        if @logs.blank? || @logs.values.all?(&:blank?)
+        if ENV[DISABLE_FETCHING_LOG_INFO]
+          helpful_info << "  - Logs: #{DISABLED_LOG_INFO_MESSAGE}"
+        elsif @logs.blank? || @logs.values.all?(&:blank?)
           helpful_info << "  - Logs: #{DEBUG_RESOURCE_NOT_FOUND_MESSAGE}"
         else
           sorted_logs = @logs.sort_by { |_, log_lines| log_lines.length }

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

@@ -48,15 +48,14 @@ module KubernetesDeploy
     def deploy_succeeded?
       return false unless @latest_rs.present?
 
-      case required_rollout
-      when 'full'
+      if required_rollout == 'full'
         @latest_rs.deploy_succeeded? &&
         @latest_rs.desired_replicas == @desired_replicas && # latest RS fully scaled up
         @rollout_data["updatedReplicas"].to_i == @desired_replicas &&
         @rollout_data["updatedReplicas"].to_i == @rollout_data["availableReplicas"].to_i
-      when 'none'
+      elsif required_rollout == 'none'
         true
-      when 'maxUnavailable'
+      elsif required_rollout == 'maxUnavailable' || percent?(required_rollout)
         minimum_needed = min_available_replicas
 
         @latest_rs.desired_replicas >= minimum_needed &&
@@ -102,7 +101,7 @@ module KubernetesDeploy
     def validate_definition
       super
 
-      unless REQUIRED_ROLLOUT_TYPES.include?(required_rollout)
+      unless REQUIRED_ROLLOUT_TYPES.include?(required_rollout) || percent?(required_rollout)
         @validation_errors << rollout_annotation_err_msg
       end
 
@@ -168,16 +167,21 @@ module KubernetesDeploy
     end
 
     def min_available_replicas
-      if @max_unavailable =~ /%/
-        (@desired_replicas * (100 - @max_unavailable.to_i) / 100.0).ceil
+      max_unavailable = percent?(required_rollout) ? "#{100 - required_rollout.to_i}%" : @max_unavailable
+
+      if max_unavailable =~ /%/
+        (@desired_replicas * (100 - max_unavailable.to_i) / 100.0).ceil
       else
-        @desired_replicas - @max_unavailable.to_i
+        @desired_replicas - max_unavailable.to_i
       end
     end
 
     def required_rollout
-      @definition.dig('metadata', 'annotations', REQUIRED_ROLLOUT_ANNOTATION).presence ||
-      DEFAULT_REQUIRED_ROLLOUT
+      @definition.dig('metadata', 'annotations', REQUIRED_ROLLOUT_ANNOTATION).presence || DEFAULT_REQUIRED_ROLLOUT
+    end
+
+    def percent?(value)
+      value =~ /\d+%/
     end
   end
 end

data/lib/kubernetes-deploy/restart_task.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'kubernetes-deploy/kubeclient_builder'
 require 'kubernetes-deploy/resource_watcher'
+require 'kubernetes-deploy/kubectl'
 
 module KubernetesDeploy
   class RestartTask
@@ -32,7 +33,9 @@ module KubernetesDeploy
       @logger.phase_heading("Initializing restart")
       verify_namespace
       deployments = identify_target_deployments(deployments_names)
-
+      if kubectl.server_version < Gem::Version.new(MIN_KUBE_VERSION)
+        @logger.warn(KubernetesDeploy::Errors.server_version_warning(kubectl.server_version))
+      end
       @logger.phase_heading("Triggering restart by touching ENV[RESTARTED_AT]")
       patch_kubeclient_deployments(deployments)
 
@@ -153,6 +156,10 @@ module KubernetesDeploy
       @kubeclient ||= build_v1_kubeclient(@context)
     end
 
+    def kubectl
+      @kubectl ||= Kubectl.new(namespace: @namespace, context: @context, logger: @logger, log_failure_by_default: true)
+    end
+
     def v1beta1_kubeclient
       @v1beta1_kubeclient ||= build_v1beta1_kubeclient(@context)
     end

data/lib/kubernetes-deploy/runner_task.rb

@@ -34,7 +34,9 @@ module KubernetesDeploy
       @logger.reset
       @logger.phase_heading("Validating configuration")
       validate_configuration(task_template, args)
-
+      if kubectl.server_version < Gem::Version.new(MIN_KUBE_VERSION)
+        @logger.warn(KubernetesDeploy::Errors.server_version_warning(kubectl.server_version))
+      end
       @logger.phase_heading("Fetching task template")
       raw_template = get_template(task_template)
 
@@ -127,7 +129,6 @@ module KubernetesDeploy
       f.write recursive_to_h(pod).to_json
       f.close
 
-      kubectl = Kubectl.new(namespace: @namespace, context: @context, logger: @logger, log_failure_by_default: true)
       _out, err, status = kubectl.run("apply", "--dry-run", "-f", f.path)
 
       unless status.success?
@@ -135,6 +136,10 @@ module KubernetesDeploy
       end
     end
 
+    def kubectl
+      @kubectl ||= Kubectl.new(namespace: @namespace, context: @context, logger: @logger, log_failure_by_default: true)
+    end
+
     def recursive_to_h(struct)
       if struct.is_a?(Array)
         return struct.map { |v| v.is_a?(OpenStruct) || v.is_a?(Array) || v.is_a?(Hash) ? recursive_to_h(v) : v }

data/lib/kubernetes-deploy/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-deploy
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.15.2
 platform: ruby
 authors:
 - Katrina Verey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport