krane 2.1.3 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a6ce0892fb00b50930df4316057572b08245e946d7eb9e60d938c76e4ba826e
-  data.tar.gz: 903999c3121acbd58162ebfffedb10fbfa22a347262c7108bc3c499527654a22
+  metadata.gz: 7ae8bb4b0c7f920136990847601e19c7767075a89ead99781213feaf309d623d
+  data.tar.gz: 90ad58122ca788ebd4010e62e624c0d73a0c153e48c942673e244e7fbb4ccb32
 SHA512:
-  metadata.gz: ca770038ea36996205013d9baae03f4acb6da0b37e57aa7f261d1c95a5846999135bb147392c1016a9c0c04377258e07e155f5f3a994e4a3e1fd8bffb69f296d
-  data.tar.gz: b1c3fc517252cd4be20cf11a7dbf2381591890aeb6074859a6058f2dfd0becd060039800704106451dff116494a4725af93c2d0175550437df1a9c94428453b1
+  metadata.gz: 7e09bdb58b4bca4380b77bb10589a2e5b57aa31e9d8838c4b6efc68ccbf58b5af84c360a1a2710564164e4d6f19419cd38d7b3952559c56d5f7dc026d432a194
+  data.tar.gz: 659649bf0d0cfbe04d3fad0f32f3a05cc6ed9e117ca0755bf808d898b60dbf0d5be88cad609de1589cd93eb2b808e6cc9994a73f7b21267920b679b71afd138e

data/.rubocop-http---shopify-github-io-ruby-style-guide-rubocop-yml

@@ -195,6 +195,7 @@ Style/FrozenStringLiteralComment:
   SupportedStyles:
     - always
     - never
+  SafeAutoCorrect: true
 
 Style/GlobalVars:
   AllowedVariables: []

data/.shopify-build/krane.yml

@@ -1,6 +1,6 @@
 containers:
   default:
-    docker: circleci/ruby:2.5.7
+    docker: circleci/ruby:2.6.6
 
 steps:
   - label: Lint
@@ -8,14 +8,29 @@ steps:
     run:
       - bundle: ~
       - bundle exec rubocop
-  - label: 'Run Test Suite (:kubernetes: 1.18-latest :ruby: 2.7)'
+  - label: 'Run Test Suite (:kubernetes: 1.20-latest :ruby: 3.0)'
     command: bin/ci
     agents:
       queue: k8s-ci
     env:
       LOGGING_LEVEL: "4"
-      KUBERNETES_VERSION: v1.18-latest
+      KUBERNETES_VERSION: v1.20-latest
+      RUBY_VERSION: "3.0"
+  - label: 'Run Test Suite (:kubernetes: 1.19-latest :ruby: 2.7)'
+    command: bin/ci
+    agents:
+      queue: k8s-ci
+    env:
+      LOGGING_LEVEL: "4"
+      KUBERNETES_VERSION: v1.19-latest
       RUBY_VERSION: "2.7"
+  - label: 'Run Test Suite (:kubernetes: 1.18-latest)'
+    command: bin/ci
+    agents:
+      queue: k8s-ci
+    env:
+      LOGGING_LEVEL: "4"
+      KUBERNETES_VERSION: v1.18-latest
   - label: 'Run Test Suite (:kubernetes: 1.17-latest)'
     command: bin/ci
     agents:
@@ -23,14 +38,13 @@ steps:
     env:
       LOGGING_LEVEL: "4"
       KUBERNETES_VERSION: v1.17-latest
-  - label: 'Run Test Suite (:kubernetes: 1.16.12)'
+  - label: 'Run Test Suite (:kubernetes: 1.16-latest)'
     command: bin/ci
     agents:
       queue: k8s-ci
     env:
       LOGGING_LEVEL: "4"
-      # Flip this back to v1.16-latest when 1.16.14 comes out (see #733)
-      KUBERNETES_VERSION: v1.16.12
+      KUBERNETES_VERSION: v1.16-latest
   - label: 'Run Test Suite (:kubernetes: 1.15-latest)'
     command: bin/ci
     agents:

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## next
 
+## 2.1.4
+
+*Enhancements*
+- Attempt to batch run server-side apply in validation phase instead of dry-running each resource individually [#781](https://github.com/Shopify/krane/pull/781).
+- Evaluate progress condition only after progress deadline seconds have passed since deploy invocation [#765](https://github.com/Shopify/krane/pull/765).
+
+*Other*
+- Dropped support for Ruby 2.5 due to EoL. [#782](https://github.com/Shopify/krane/pull/782).
+- Only patch JSON when run as CLI, not as library [#779](https://github.com/Shopify/krane/pull/779).
+
 ## 2.1.3
 
 - Add version exception for ServiceNetworkEndpointGroup (GKE resource) [#768](https://github.com/Shopify/krane/pull/768)

data/README.md

@@ -1,4 +1,4 @@
-# krane [![Build status](https://badge.buildkite.com/35c56e797c3bbd6ba50053aefdded0715898cd8e8c86f7e462.svg?branch=master)](https://buildkite.com/shopify/krane) [![codecov](https://codecov.io/gh/Shopify/kubernetes-deploy/branch/master/graph/badge.svg)](https://codecov.io/gh/Shopify/kubernetes-deploy)
+# krane [![Build status](https://badge.buildkite.com/35c56e797c3bbd6ba50053aefdded0715898cd8e8c86f7e462.svg?branch=master)](https://buildkite.com/shopify/krane)
 
 > This project used to be called `kubernetes-deploy`. Check out our [migration guide](https://github.com/Shopify/krane/blob/master/1.0-Upgrade.md) for more information including details about breaking changes.
 
@@ -73,7 +73,7 @@ If you need the ability to render dynamic values in templates before deploying,
 
 ## Prerequisites
 
-* Ruby 2.5+
+* Ruby 2.6+
 * Your cluster must be running Kubernetes v1.15.0 or higher<sup>1</sup>
 
 <sup>1</sup> We run integration tests against these Kubernetes versions. You can find our

data/bin/ci

@@ -12,10 +12,9 @@ docker run --rm \
     -v "$PWD":/usr/src/app \
     -v "/usr/bin/kubectl":"/usr/bin/kubectl" \
     -e CI=1 \
-    -e CODECOV_TOKEN=$CODECOV_TOKEN \
     -e COVERAGE=1 \
     -e VERBOSE=1 \
     -e PARALLELISM=$PARALLELISM \
     -w /usr/src/app \
-    ruby:"${RUBY_VERSION:-2.5}" \
+    ruby:"${RUBY_VERSION:-2.6.6}" \
     bin/test

data/dev.yml

@@ -1,7 +1,7 @@
 ---
 name: krane
 up:
-  - ruby: 2.5.7 # Matches gemspec
+  - ruby: 2.6.6 # Matches gemspec
   - bundler
   - homebrew:
     - homebrew/cask/minikube

data/krane.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = "https://rubygems.org"
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.6.0'
   spec.add_dependency("activesupport", ">= 5.0")
   spec.add_dependency("kubeclient", "~> 4.3")
   spec.add_dependency("googleauth", "~> 0.8")
@@ -57,5 +57,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency("ruby-prof")
   spec.add_development_dependency("ruby-prof-flamegraph")
   spec.add_development_dependency("rubocop", "~> 0.89.1")
-  spec.add_development_dependency("codecov")
+  spec.add_development_dependency("simplecov")
 end

data/lib/krane/cli/krane.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-
 require 'krane'
+require 'krane/oj'
 require 'thor'
 require 'krane/cli/version_command'
 require 'krane/cli/restart_command'

data/lib/krane/cluster_resource_discovery.rb

@@ -23,9 +23,7 @@ module Krane
       fetch_resources(namespaced: namespaced).uniq { |r| r['kind'] }.map do |resource|
         next unless resource['verbs'].one? { |v| v == "delete" }
         next if black_list.include?(resource['kind'])
-        group_versions = api_versions[resource['apigroup'].to_s]
-        version = version_for_kind(group_versions, resource['kind'])
-        [resource['apigroup'], version, resource['kind']].compact.join("/")
+        gvk_string(api_versions, resource)
       end.compact
     end
 
@@ -90,7 +88,9 @@ module Krane
                            "CSIDriver" => "v1beta1", "Ingress" => "v1beta1",
                            "CSINode" => "v1beta1", "Job" => "v1",
                            "IngressClass" => "v1beta1", "FrontendConfig" => "v1beta1",
-                           "ServiceNetworkEndpointGroup" => "v1beta1" }
+                           "ServiceNetworkEndpointGroup" => "v1beta1",
+                           "EnvoyFilter" => "v1alpha3",
+                           "TCPIngress" => "v1beta1" }
 
       pattern = /v(?<major>\d+)(?<pre>alpha|beta)?(?<minor>\d+)?/
       latest = versions.sort_by do |version|
@@ -101,6 +101,23 @@ module Krane
       version_override.fetch(kind, latest)
     end
 
+    def gvk_string(api_versions, resource)
+      apiversion = resource['apiversion'].to_s
+
+      ## In kubectl 1.20 APIGroups was replaced by APIVersions
+      if apiversion.empty?
+        apigroup = resource['apigroup'].to_s
+        group_versions = api_versions[apigroup]
+
+        version = version_for_kind(group_versions, resource['kind'])
+        apigroup = 'core' if apigroup.empty?
+        apiversion = "#{apigroup}/#{version}"
+      end
+
+      apiversion = "core/#{apiversion}" unless apiversion.include?("/")
+      [apiversion, resource['kind']].compact.join("/")
+    end
+
     def fetch_crds
       raw_json, err, st = kubectl.run("get", "CustomResourceDefinition", output: "json", attempts: 5,
         use_namespace: false)

data/lib/krane/common.rb

@@ -11,7 +11,6 @@ require 'active_support/core_ext/array/conversions'
 require 'colorized_string'
 
 require 'krane/version'
-require 'krane/oj'
 require 'krane/errors'
 require 'krane/formatted_logger'
 require 'krane/statsd'

data/lib/krane/deploy_task.rb

@@ -279,13 +279,17 @@ module Krane
 
     def validate_resources(resources)
       validate_globals(resources)
+      batch_dry_run_success = validate_dry_run(resources)
       Krane::Concurrency.split_across_threads(resources) do |r|
-        r.validate_definition(kubectl, selector: @selector)
+        # No need to pass in kubectl (and do per-resource dry run apply) if batch dry run succeeded
+        if batch_dry_run_success
+          r.validate_definition(kubectl: nil, selector: @selector, dry_run: false)
+        else
+          r.validate_definition(kubectl: kubectl, selector: @selector, dry_run: true)
+        end
       end
-
       failed_resources = resources.select(&:validation_failed?)
       if failed_resources.present?
-
         failed_resources.each do |r|
           content = File.read(r.file_path) if File.file?(r.file_path) && !r.sensitive_template_content?
           record_invalid_template(logger: @logger, err: r.validation_error_msg,
@@ -308,6 +312,10 @@ module Krane
         "Use GlobalDeployTask instead."
     end
 
+    def validate_dry_run(resources)
+      resource_deployer.dry_run(resources)
+    end
+
     def namespace_definition
       @namespace_definition ||= begin
         definition, _err, st = kubectl.run("get", "namespace", @namespace, use_namespace: false,

data/lib/krane/ejson_secret_provisioner.rb

@@ -53,7 +53,7 @@ module Krane
         secrets.map do |secret_name, secret_spec|
           validate_secret_spec(secret_name, secret_spec)
           resource = generate_secret_resource(secret_name, secret_spec["_type"], secret_spec["data"])
-          resource.validate_definition(@kubectl)
+          resource.validate_definition(kubectl: @kubectl)
           if resource.validation_failed?
             raise EjsonSecretError, "Resulting resource Secret/#{secret_name} failed validation"
           end

data/lib/krane/global_deploy_task.rb

@@ -131,7 +131,7 @@ module Krane
       validate_globals(resources)
 
       Concurrency.split_across_threads(resources) do |r|
-        r.validate_definition(@kubectl, selector: @selector)
+        r.validate_definition(kubectl: @kubectl, selector: @selector)
       end
 
       failed_resources = resources.select(&:validation_failed?)

data/lib/krane/kubectl.rb

@@ -100,6 +100,14 @@ module Krane
       server_version >= Gem::Version.new(SERVER_DRY_RUN_MIN_VERSION)
     end
 
+    def dry_run_flag
+      if server_version >= Gem::Version.new("1.18")
+        "--dry-run=server"
+      else
+        "--server-dry-run"
+      end
+    end
+
     private
 
     def build_command_from_options(args, use_namespace, use_context, output)

data/lib/krane/kubernetes_resource.rb

@@ -134,12 +134,12 @@ module Krane
       Kubeclient::Resource.new(@definition)
     end
 
-    def validate_definition(kubectl, selector: nil)
+    def validate_definition(kubectl:, selector: nil, dry_run: true)
       @validation_errors = []
       validate_selector(selector) if selector
       validate_timeout_annotation
       validate_deploy_method_override_annotation
-      validate_spec_with_kubectl(kubectl)
+      validate_spec_with_kubectl(kubectl) if dry_run
       @validation_errors.present?
     end
 
@@ -560,7 +560,12 @@ module Krane
 
     # Server side dry run is only supported on apply
     def validate_with_server_side_dry_run(kubectl)
-      command = ["apply", "-f", file_path, "--server-dry-run", "--output=name"]
+      command = if kubectl.server_version >= Gem::Version.new('1.18')
+        ["apply", "-f", file_path, "--dry-run=server", "--output=name"]
+      else
+        ["apply", "-f", file_path, "--server-dry-run", "--output=name"]
+      end
+
       kubectl.run(*command, log_failure: false, output_is_sensitive: sensitive_template_content?,
         retry_whitelist: [:client_timeout, :empty, :context_deadline], attempts: 3)
     end

data/lib/krane/kubernetes_resource/deployment.rb

@@ -155,6 +155,8 @@ module Krane
 
     def deploy_failing_to_progress?
       return false unless progress_condition.present?
+      # Ensure at least progress_deadline wall clock time has passed before before examining progress_condition
+      return false if deploy_started? && Time.now.utc - @deploy_started_at < progress_deadline
 
       # This assumes that when the controller bumps the observed generation, it also updates/clears all the status
       # conditions. Specifically, it assumes the progress condition is immediately set to True if a rollout is starting.

data/lib/krane/resource_deployer.rb

@@ -20,6 +20,13 @@ module Krane
       @statsd_tags = statsd_tags
     end
 
+    def dry_run(resources)
+      apply_all(resources, true, dry_run: true)
+      true
+    rescue FatalDeploymentError
+      false
+    end
+
     def deploy!(resources, verify_result, prune)
       if verify_result
         deploy_all_resources(resources, prune: prune, verify: true)
@@ -128,17 +135,17 @@ module Krane
       end
     end
 
-    def apply_all(resources, prune)
+    def apply_all(resources, prune, dry_run: false)
       return unless resources.present?
-      command = %w(apply)
+      start = Time.now.utc
 
+      command = %w(apply)
       Dir.mktmpdir do |tmp_dir|
         resources.each do |r|
           FileUtils.symlink(r.file_path, tmp_dir)
-          r.deploy_started_at = Time.now.utc
+          r.deploy_started_at = Time.now.utc unless dry_run
         end
         command.push("-f", tmp_dir)
-
         if prune && @prune_whitelist.present?
           command.push("--prune")
           if @selector
@@ -149,20 +156,22 @@ module Krane
           @prune_whitelist.each { |type| command.push("--prune-whitelist=#{type}") }
         end
 
+        command.push(kubectl.dry_run_flag) if dry_run
         output_is_sensitive = resources.any?(&:sensitive_template_content?)
         global_mode = resources.all?(&:global?)
         out, err, st = kubectl.run(*command, log_failure: false, output_is_sensitive: output_is_sensitive,
           attempts: 2, use_namespace: !global_mode)
 
+        tags = statsd_tags + (dry_run ? ['dry_run:true'] : ['dry_run:false'])
+        Krane::StatsD.client.distribution('apply_all.duration', Krane::StatsD.duration(start), tags: tags)
         if st.success?
           log_pruning(out) if prune
         else
-          record_apply_failure(err, resources: resources)
+          record_apply_failure(err, resources: resources) unless dry_run
           raise FatalDeploymentError, "Command failed: #{Shellwords.join(command)}"
         end
       end
     end
-    measure_method(:apply_all)
 
     def log_pruning(kubectl_output)
       pruned = kubectl_output.scan(/^(.*) pruned$/)

data/lib/krane/runner_task.rb

@@ -118,7 +118,7 @@ module Krane
     end
 
     def validate_pod(pod)
-      pod.validate_definition(kubectl)
+      pod.validate_definition(kubectl: kubectl)
     end
 
     def watch_pod(pod)

data/lib/krane/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Krane
-  VERSION = "2.1.3"
+  VERSION = "2.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: krane
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.1.4
 platform: ruby
 authors:
 - Katrina Verey
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-14 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -375,7 +375,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.89.1
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -511,7 +511,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="