kubernetes-deploy 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b7eaf966de6685ee13686190feda92f7d5e249c
-  data.tar.gz: 7bc442ae69145779cd8965caababf22545a5d954
+  metadata.gz: 6f73fbf31b907e647a5c5fb9f37672cda04f2fbb
+  data.tar.gz: 37ff614545966a6aed17f814e71f244ec571c0de
 SHA512:
-  metadata.gz: 983f99b3be92381d2838bc7b7cd4d9efd4220e9b13cd68d795d1d5523cd550d15effea7da8dc273d6dec8825e23372a63ff82a05e577ebcbdac0a3c2b9c2095b
-  data.tar.gz: 28eb00deaa911348e3d27be549bcd0c788e8efc00977edd1c3986521b9e82367b06a8d80a258a371ec9dcd9d4b9dc7100d6e4856f0f98596fd2ab2b43dfd005b
+  metadata.gz: da6efb2e3f67dcb4e322559fb39deaa2d87606269cb1f1ab1f1609cc4a01d7af766e0bae0483a1ad448143de4f3db80a81938221a9bff6daefb4e475c0400d11
+  data.tar.gz: 5991bc3e2dc085d46c28ad3c11fc057cf9bbc79785cd2b92bef41b9d637e96b2b74650852ab7bdc574f1f3b8d55ea7a3513e94440fe360292c3dc876833b46f8

data/.buildkite/pipeline.nightly.yml

@@ -1,3 +1,10 @@
+  - name: 'Run Test Suite (:kubernetes: 1.10-latest)'
+    command: bin/ci
+    agents:
+      queue: minikube-ci
+    env:
+      LOGGING_LEVEL: 4
+      KUBERNETES_VERSION: v1.10-latest
   - name: 'Run Test Suite (:kubernetes: 1.9-latest)'
     command: bin/ci
     agents:

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 0.15.0
+*Bug Fixes*
+- None
+
+*Enhancements*
+- Support for cronjob resource ([#206](https://github.com/Shopify/kubernetes-deploy/pull/206])).
+- Make it possible to override the tool's hard timeout for one specific resource via the `kubernetes-deploy.shopify.io/timeout-override`
+annotation ([#232](https://github.com/Shopify/kubernetes-deploy/pull/232)).
+- Make it possible to modify how many replicas need to be updated and available before a deployment is considered
+successful via the `kubernetes-deploy.shopify.io/required-rollout` annotation ([#208](https://github.com/Shopify/kubernetes-deploy/pull/208)).
+
 ### 0.14.1
 *Bug Fixes*
 - Make deployments whose pods crash because of CreateContainerConfigError fail fast in 1.8+ too (they would previously time out).

data/README.md

@@ -39,6 +39,7 @@ This repo also includes related tools for [running tasks](#kubernetes-run) and [
 * [Installation](#installation)
 * [Usage](#usage)
   * [Using templates and variables](#using-templates-and-variables)
+  * [Customizing behaviour with annotations](#customizing-behaviour-with-annotations)
   * [Running tasks at the beginning of a deploy](#running-tasks-at-the-beginning-of-a-deploy)
   * [Deploying Kubernetes secrets (from EJSON)](#deploying-kubernetes-secrets-from-ejson)
 
@@ -120,6 +121,20 @@ All templates must be YAML formatted. You can also use ERB. The following local
 You can add additional variables using the `--bindings=BINDINGS` option. For example, `kubernetes-deploy my-app cluster1 --bindings=color=blue,size=large` will expose `color` and `size` in your templates.
 
 
+### Customizing behaviour with annotations
+- `kubernetes-deploy.shopify.io/timeout-override`: Override the tool's hard timeout for one specific resource. Both full ISO8601 durations and the time portion of ISO8601 durations are valid. Value must be between 1 second and 24 hours.
+  - _Example values_: 45s / 3m / 1h / PT0.25H
+  - _Compatibility_: all resource types (Note: `Deployment` timeouts are based on `spec.progressDeadlineSeconds` if present, and that field has a default value as of the `apps/v1beta1` group version. Using this annotation will have no effect on `Deployment`s that time out with "Timeout reason: ProgressDeadlineExceeded".)
+- `kubernetes-deploy.shopify.io/required-rollout`: Modifies how much of the rollout needs to finish
+before the deployment is considered successful.
+  - _Compatibility_: Deployment
+  - `full`: The deployment is successful when all pods in the new `replicaSet` are ready.
+  - `none`: The deployment is successful as soon as the new `replicaSet` is created for the deployment.
+  - `maxUnavailable`: The deploy is successful when minimum availability is reached in the new `replicaSet`.
+  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.
+
 
 ### Running tasks at the beginning of a deploy
 

data/lib/kubernetes-deploy/deploy_task.rb

@@ -28,6 +28,7 @@ require 'kubernetes-deploy/kubernetes_resource'
   topic
   bucket
   stateful_set
+  cron_job
 ).each do |subresource|
   require "kubernetes-deploy/kubernetes_resource/#{subresource}"
 end
@@ -65,18 +66,28 @@ module KubernetesDeploy
     # core/v1/ReplicationController -- superseded by deployments/replicasets
     # extensions/v1beta1/ReplicaSet -- managed by deployments
     # core/v1/Secret -- should not committed / managed by shipit
-    PRUNE_WHITELIST = %w(
-      core/v1/ConfigMap
-      core/v1/Pod
-      core/v1/Service
-      batch/v1/Job
-      extensions/v1beta1/DaemonSet
-      extensions/v1beta1/Deployment
-      apps/v1beta1/Deployment
-      extensions/v1beta1/Ingress
-      apps/v1beta1/StatefulSet
-      autoscaling/v1/HorizontalPodAutoscaler
-    ).freeze
+    def prune_whitelist
+      wl = %w(
+        core/v1/ConfigMap
+        core/v1/Pod
+        core/v1/Service
+        batch/v1/Job
+        extensions/v1beta1/DaemonSet
+        extensions/v1beta1/Deployment
+        apps/v1beta1/Deployment
+        extensions/v1beta1/Ingress
+        apps/v1beta1/StatefulSet
+        autoscaling/v1/HorizontalPodAutoscaler
+      )
+      if server_version >= Gem::Version.new('1.8.0')
+        wl << "batch/v1beta1/CronJob"
+      end
+      wl
+    end
+
+    def server_version
+      kubectl.server_version
+    end
 
     NOT_FOUND_ERROR = 'NotFound'
 
@@ -383,7 +394,7 @@ module KubernetesDeploy
 
       if prune
         command.push("--prune", "--all")
-        PRUNE_WHITELIST.each { |type| command.push("--prune-whitelist=#{type}") }
+        prune_whitelist.each { |type| command.push("--prune-whitelist=#{type}") }
       end
 
       out, err, st = kubectl.run(*command, log_failure: false)

data/lib/kubernetes-deploy/duration_parser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module KubernetesDeploy
+  ##
+  # This class is a less strict extension of ActiveSupport::Duration::ISO8601Parser.
+  # In addition to full ISO8601 durations, it can parse unprefixed ISO8601 time components (e.g. '1H').
+  # It is also case-insensitive.
+  # For example, this class considers the values "1H", "1h" and "PT1H" to be valid and equivalent.
+
+  class DurationParser
+    class ParsingError < ArgumentError; end
+
+    def initialize(value)
+      @iso8601_str = value.to_s.strip.upcase
+    end
+
+    def parse!
+      ActiveSupport::Duration.parse("PT#{@iso8601_str}") # By default assume it is just a time component
+    rescue ActiveSupport::Duration::ISO8601Parser::ParsingError
+      begin
+        ActiveSupport::Duration.parse(@iso8601_str)
+      rescue ActiveSupport::Duration::ISO8601Parser::ParsingError => e
+        raise ParsingError, e.message
+      end
+    end
+  end
+end

data/lib/kubernetes-deploy/kubeclient_builder.rb

@@ -28,6 +28,14 @@ module KubernetesDeploy
       )
     end
 
+    def build_batch_v1beta1_kubeclient(context)
+      _build_kubeclient(
+        api_version: "v1beta1",
+        context: context,
+        endpoint_path: "/apis/batch/"
+      )
+    end
+
     def build_policy_v1beta1_kubeclient(context)
       _build_kubeclient(
         api_version: "v1beta1",

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module KubernetesDeploy
+  class CronJob < KubernetesResource
+    TIMEOUT = 30.seconds
+
+    def sync
+      _, _err, st = kubectl.run("get", type, @name)
+      @status = st.success? ? "Available" : "Unknown"
+      @found = st.success?
+    end
+
+    def deploy_succeeded?
+      exists?
+    end
+
+    def deploy_failed?
+      !exists?
+    end
+
+    def timeout_message
+      UNUSUAL_FAILURE_MESSAGE
+    end
+
+    def exists?
+      @found
+    end
+  end
+end

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

@@ -2,6 +2,9 @@
 module KubernetesDeploy
   class Deployment < KubernetesResource
     TIMEOUT = 7.minutes
+    REQUIRED_ROLLOUT_ANNOTATION = 'kubernetes-deploy.shopify.io/required-rollout'
+    REQUIRED_ROLLOUT_TYPES = %w(maxUnavailable full none).freeze
+    DEFAULT_REQUIRED_ROLLOUT = 'full'
 
     def sync
       raw_json, _err, st = kubectl.run("get", type, @name, "--output=json")
@@ -19,6 +22,7 @@ module KubernetesDeploy
         conditions = deployment_data.fetch("status", {}).fetch("conditions", [])
         @progress_condition = conditions.find { |condition| condition['type'] == 'Progressing' }
         @progress_deadline = deployment_data['spec']['progressDeadlineSeconds']
+        @max_unavailable = deployment_data.dig('spec', 'strategy', 'rollingUpdate', 'maxUnavailable')
       else # reset
         @latest_rs = nil
         @rollout_data = { "replicas" => 0 }
@@ -26,6 +30,7 @@ module KubernetesDeploy
         @progress_condition = nil
         @progress_deadline = @definition['spec']['progressDeadlineSeconds']
         @desired_replicas = -1
+        @max_unavailable = @definition.dig('spec', 'strategy', 'rollingUpdate', 'maxUnavailable')
       end
     end
 
@@ -43,10 +48,23 @@ module KubernetesDeploy
     def deploy_succeeded?
       return false unless @latest_rs.present?
 
-      @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
+      case required_rollout
+      when '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'
+        true
+      when 'maxUnavailable'
+        minimum_needed = min_available_replicas
+
+        @latest_rs.desired_replicas >= minimum_needed &&
+        @latest_rs.ready_replicas >= minimum_needed &&
+        @latest_rs.available_replicas >= minimum_needed
+      else
+        raise FatalDeploymentError, rollout_annotation_err_msg
+      end
     end
 
     def deploy_failed?
@@ -81,8 +99,29 @@ module KubernetesDeploy
       @found
     end
 
+    def validate_definition
+      super
+
+      unless REQUIRED_ROLLOUT_TYPES.include?(required_rollout)
+        @validation_errors << rollout_annotation_err_msg
+      end
+
+      strategy = @definition.dig('spec', 'strategy', 'type').to_s
+      if required_rollout.downcase == 'maxunavailable' && strategy.downcase != 'rollingupdate'
+        @validation_errors << "'#{REQUIRED_ROLLOUT_ANNOTATION}: #{required_rollout}' is incompatible "\
+        "with strategy '#{strategy}'"
+      end
+
+      @validation_errors.empty?
+    end
+
     private
 
+    def rollout_annotation_err_msg
+      "'#{REQUIRED_ROLLOUT_ANNOTATION}: #{required_rollout}' is invalid. "\
+        "Acceptable values: #{REQUIRED_ROLLOUT_TYPES.join(', ')}"
+    end
+
     def deploy_failing_to_progress?
       return false unless @progress_condition.present?
 
@@ -98,18 +137,22 @@ module KubernetesDeploy
       Time.parse(@progress_condition["lastUpdateTime"]).to_i >= (@deploy_started_at - 5.seconds).to_i
     end
 
-    def find_latest_rs(deployment_data)
-      label_string = deployment_data["spec"]["selector"]["matchLabels"].map { |k, v| "#{k}=#{v}" }.join(",")
+    def all_rs_data(match_labels)
+      label_string = match_labels.map { |k, v| "#{k}=#{v}" }.join(",")
       raw_json, _err, st = kubectl.run("get", "replicasets", "--output=json", "--selector=#{label_string}")
-      return unless st.success?
+      return {} unless st.success?
+
+      JSON.parse(raw_json)["items"]
+    end
 
-      all_rs_data = JSON.parse(raw_json)["items"]
+    def find_latest_rs(deployment_data)
       current_revision = deployment_data["metadata"]["annotations"]["deployment.kubernetes.io/revision"]
 
-      latest_rs_data = all_rs_data.find do |rs|
+      latest_rs_data = all_rs_data(deployment_data["spec"]["selector"]["matchLabels"]).find do |rs|
         rs["metadata"]["ownerReferences"].any? { |ref| ref["uid"] == deployment_data["metadata"]["uid"] } &&
         rs["metadata"]["annotations"]["deployment.kubernetes.io/revision"] == current_revision
       end
+
       return unless latest_rs_data.present?
 
       rs = ReplicaSet.new(
@@ -123,5 +166,18 @@ module KubernetesDeploy
       rs.sync(latest_rs_data)
       rs
     end
+
+    def min_available_replicas
+      if @max_unavailable =~ /%/
+        (@desired_replicas * (100 - @max_unavailable.to_i) / 100.0).ceil
+      else
+        @desired_replicas - @max_unavailable.to_i
+      end
+    end
+
+    def required_rollout
+      @definition.dig('metadata', 'annotations', REQUIRED_ROLLOUT_ANNOTATION).presence ||
+      DEFAULT_REQUIRED_ROLLOUT
+    end
   end
 end

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

@@ -3,13 +3,15 @@ require 'kubernetes-deploy/kubernetes_resource/pod_set_base'
 module KubernetesDeploy
   class ReplicaSet < PodSetBase
     TIMEOUT = 5.minutes
-    attr_reader :desired_replicas, :pods
+    attr_reader :desired_replicas, :ready_replicas, :available_replicas, :pods
 
     def initialize(namespace:, context:, definition:, logger:, parent: nil, deploy_started_at: nil)
       @parent = parent
       @deploy_started_at = deploy_started_at
       @rollout_data = { "replicas" => 0 }
       @desired_replicas = -1
+      @ready_replicas = -1
+      @available_replicas = -1
       @pods = []
       super(namespace: namespace, context: context, definition: definition, logger: logger)
     end
@@ -26,6 +28,8 @@ module KubernetesDeploy
         @rollout_data = { "replicas" => 0 }.merge(
           rs_data["status"].slice("replicas", "availableReplicas", "readyReplicas")
         )
+        @ready_replicas = @rollout_data['readyReplicas'].to_i
+        @available_replicas = @rollout_data["availableReplicas"].to_i
         @status = @rollout_data.map { |state_replicas, num| "#{num} #{state_replicas.chop.pluralize(num)}" }.join(", ")
         @pods = find_pods(rs_data)
       else # reset
@@ -34,6 +38,8 @@ module KubernetesDeploy
         @status = nil
         @pods = []
         @desired_replicas = -1
+        @ready_replicas = -1
+        @available_replicas = -1
       end
     end
 

data/lib/kubernetes-deploy/kubernetes_resource.rb

@@ -6,7 +6,7 @@ require 'kubernetes-deploy/kubectl'
 
 module KubernetesDeploy
   class KubernetesResource
-    attr_reader :name, :namespace, :context, :validation_error_msg
+    attr_reader :name, :namespace, :context
     attr_writer :type, :deploy_started_at
 
     TIMEOUT = 5.minutes
@@ -22,6 +22,8 @@ module KubernetesDeploy
       If you have reason to believe it will succeed, retry the deploy to continue to monitor the rollout.
       MSG
 
+    TIMEOUT_OVERRIDE_ANNOTATION = "kubernetes-deploy.shopify.io/timeout-override"
+
     def self.build(namespace:, context:, definition:, logger:)
       opts = { namespace: namespace, context: context, definition: definition, logger: logger }
       if KubernetesDeploy.const_defined?(definition["kind"])
@@ -39,9 +41,17 @@ module KubernetesDeploy
     end
 
     def timeout
+      return timeout_override if timeout_override.present?
       self.class.timeout
     end
 
+    def timeout_override
+      return @timeout_override if defined?(@timeout_override)
+      @timeout_override = DurationParser.new(timeout_annotation).parse!.to_i
+    rescue DurationParser::ParsingError
+      @timeout_override = nil
+    end
+
     def pretty_timeout_type
       "timeout: #{timeout}s"
     end
@@ -59,20 +69,26 @@ module KubernetesDeploy
       @logger = logger
       @definition = definition
       @statsd_report_done = false
-      @validation_error_msg = nil
+      @validation_errors = []
     end
 
     def validate_definition
-      @validation_error_msg = nil
+      @validation_errors = []
+      validate_timeout_annotation
+
       command = ["create", "-f", file_path, "--dry-run", "--output=name"]
       _, err, st = kubectl.run(*command, log_failure: false)
       return true if st.success?
-      @validation_error_msg = err
+      @validation_errors << err
       false
     end
 
+    def validation_error_msg
+      @validation_errors.join("\n")
+    end
+
     def validation_failed?
-      @validation_error_msg.present?
+      @validation_errors.present?
     end
 
     def id
@@ -277,6 +293,23 @@ module KubernetesDeploy
 
     private
 
+    def validate_timeout_annotation
+      return if timeout_annotation.nil?
+
+      override = DurationParser.new(timeout_annotation).parse!
+      if override <= 0
+        @validation_errors << "#{TIMEOUT_OVERRIDE_ANNOTATION} annotation is invalid: Value must be greater than 0"
+      elsif override > 24.hours
+        @validation_errors << "#{TIMEOUT_OVERRIDE_ANNOTATION} annotation is invalid: Value must be less than 24h"
+      end
+    rescue DurationParser::ParsingError => e
+      @validation_errors << "#{TIMEOUT_OVERRIDE_ANNOTATION} annotation is invalid: #{e}"
+    end
+
+    def timeout_annotation
+      @definition.dig("metadata", "annotations", TIMEOUT_OVERRIDE_ANNOTATION)
+    end
+
     def file
       @file ||= create_definition_tempfile
     end

data/lib/kubernetes-deploy/version.rb

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

data/lib/kubernetes-deploy.rb

@@ -8,6 +8,7 @@ require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/string/strip'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/array/conversions'
+require 'active_support/duration'
 require 'colorized_string'
 
 require 'kubernetes-deploy/version'
@@ -17,6 +18,7 @@ require 'kubernetes-deploy/deploy_task'
 require 'kubernetes-deploy/statsd'
 require 'kubernetes-deploy/concurrency'
 require 'kubernetes-deploy/bindings_parser'
+require 'kubernetes-deploy/duration_parser'
 
 module KubernetesDeploy
   KubernetesDeploy::StatsD.build

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-deploy
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Katrina Verey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -227,6 +227,7 @@ files:
 - lib/kubernetes-deploy/concurrency.rb
 - lib/kubernetes-deploy/deferred_summary_logging.rb
 - lib/kubernetes-deploy/deploy_task.rb
+- lib/kubernetes-deploy/duration_parser.rb
 - lib/kubernetes-deploy/ejson_secret_provisioner.rb
 - lib/kubernetes-deploy/errors.rb
 - lib/kubernetes-deploy/formatted_logger.rb
@@ -238,6 +239,7 @@ files:
 - lib/kubernetes-deploy/kubernetes_resource/bugsnag.rb
 - lib/kubernetes-deploy/kubernetes_resource/cloudsql.rb
 - lib/kubernetes-deploy/kubernetes_resource/config_map.rb
+- lib/kubernetes-deploy/kubernetes_resource/cron_job.rb
 - lib/kubernetes-deploy/kubernetes_resource/daemon_set.rb
 - lib/kubernetes-deploy/kubernetes_resource/deployment.rb
 - lib/kubernetes-deploy/kubernetes_resource/elasticsearch.rb
@@ -287,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Kubernetes deploy scripts