krane 2.4.1 → 2.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f7d9e842d616ea60e2c509f5e5a3fcb54d24375d426efd0345ba3a07dd2008
-  data.tar.gz: 24ccdd3165654319b55632a866f85839268644cb32ee719f55f03de6e5f63eb6
+  metadata.gz: 19143bcc0bff115c5217d341827f0ff1d599598d86aa580fcbb73c53ddc035dd
+  data.tar.gz: 05fa737ceb0bf4150b27be5e9d80ad24e37fed4479805bc54dfbe93f0feff081
 SHA512:
-  metadata.gz: 1c90430d28fe8513dd86aef6d160e04257beb66f294b998d780c66b27d8bdb7e5320947b06894399c49bcb336795f72a338fb197f3be4626467bfb286bbde2f0
-  data.tar.gz: 98fc07319ed605978d558777cea947a187bf3857d229b95945096d446fdbacd2637102e34a9e03afb9f5472105ce39d5d396f9c1cf8bc6f4c0677f28e6b88e9b
+  metadata.gz: 1bb4fc65f921987387d8858b468fba3ed1f1f8fb00539e64ca75fa0c0cc817a87d87f9f59503feae19315d08ce54f0037b803a7c3638149cabc0eec46af99d94
+  data.tar.gz: 61efdb8c0a9a6ccfeee0414b0df447b64a4dabe5a88afcd10a630819c8b26629f14ac05f09eb11e5d68d48a8f4b2c899abbfe40e5effc78666a33907d2cc3304

data/.github/workflows/ci.yml

@@ -12,6 +12,7 @@ jobs:
       matrix:
         ruby:
         # Use unique Ruby versions, or GitHub gets confused when building the rest of the matrix
+        - '3.1.2' # With k8s 1.23
         - '3.0.3' # With k8s 1.23
         - '3.0.2' # With k8s 1.22
         - '3.0.1' # With k8s 1.21
@@ -19,6 +20,10 @@ jobs:
         - '2.7' # With k8s 1.19
         include:
         # Match kind images with chosen version https://github.com/kubernetes-sigs/kind/releases
+        - ruby: '3.1.2'
+          kind_version: 'v0.11.1'
+          kubernetes_version: '1.23.0'
+          kind_image: 'kindest/node:v1.23.0@sha256:49824ab1727c04e56a21a5d8372a402fcd32ea51ac96a2706a12af38934f81ac'
         - ruby: '3.0.3'
           kind_version: 'v0.11.1'
           kubernetes_version: '1.23.0'

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 ## next
 
+## 2.4.9
+
+- Fixed a Ruby 3.1 regression that caused an exception when using a `--bindings=@<file>` argument to `krane render` [#900](https://github.com/Shopify/krane/pull/900)
+
+## 2.4.8
+
+- update googleauth gem version to 1.2
+- add the `ruby-lsp` gem to development group in the Gemfile
+## 2.4.7
+
+*Bug fixes*
+
+- Fix `replace-force` deployment method override.
+```
+/usr/local/bundle/gems/krane-2.4.6/lib/krane/resource_deployer.rb:119:in `block in deploy_resources': Unexpected deploy method! (:"replace-force") (ArgumentError)
+```
+Dash (-) must be replaced with underscore (_) before applying it as method on kubernetes resource.
+
+## 2.4.6
+
+*Bug fixes*
+
+- Extend [#886](https://github.com/Shopify/krane/pull/886) to not only secrets but anything that doesn't match `failed to sync %s cache` [#886](https://github.com/Shopify/krane/pull/886)
+It seems an issue when too many pods are referencing the same secret/configmap https://github.com/kubernetes/kubernetes/pull/74755, so instead of failing fast, it'll now let the resources attempt to succeed.
+- Add missing unit test for above feature.
+
+## 2.4.5
+
+*Bug fixes*
+
+- Do not fail fast for CreateContainerConfigError when message include issues mounting the secret, to let the pods be recreated and possible succeed [#885](https://github.com/Shopify/krane/pull/885)
+
+## 2.4.4
+
+*Enhancements*
+
+- Improve DaemonSet rollout by ignoring `Evicted` Pods [#883](https://github.com/Shopify/krane/pull/883)
+
+## 2.4.3
+
+*Enhancements*
+
+- Improve DaemonSet rollout [#881](https://github.com/Shopify/krane/pull/881)
+
+## 2.4.2
+
+*Bug fixes*
+
+- Resolve errors for StatefulSet restart with `updateStrategy: OnDelete` [#876](https://github.com/Shopify/krane/pull/876)
+- Timeouts during the "predeploy priority resources" phase now raise `DeploymentTimeoutError` instead of `FatalDeploymentError` [#874](https://github.com/Shopify/krane/pull/874)
+
 ## 2.4.1
 
 *Enhancements*

data/Gemfile

@@ -3,3 +3,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in krane.gemspec
 gemspec
+
+gem "ruby-lsp", "~> 0.2.0", :group => :development

data/dev.yml

@@ -3,19 +3,10 @@ name: krane
 up:
   - ruby: '3.0.3' # Matches gemspec
   - bundler
-  - custom:
-      name: Install Kubernetes in Docker (KinD)
-      met?: bin/kind version 2>&1 | grep -q v0.11.1
-      meet: |
-        mkdir -p bin
-        curl -sLo bin/kind "https://github.com/kubernetes-sigs/kind/releases/download/v0.11.1/kind-darwin-amd64"
-        chmod +x bin/kind
-  - custom:
-      name: Create KinD Cluster
-      met?: bin/kind get clusters | grep -q krane
-      meet: bin/kind create cluster --name krane --image "kindest/node:v1.22.0@sha256:b8bda84bb3a190e6e028b1760d277454a72267a5454b57db34437c34a588d047"
-      down: |
-        ((bin/kind get clusters | grep -q krane) && bin/kind delete cluster --name krane) || true
+  - podman
+  - kind:
+      name: krane
+      image: kindest/node:v1.22.0@sha256:b8bda84bb3a190e6e028b1760d277454a72267a5454b57db34437c34a588d047
 commands:
   test:
     run: bin/test

data/krane.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6.0'
   spec.add_dependency("activesupport", ">= 5.0")
   spec.add_dependency("kubeclient", "~> 4.9")
-  spec.add_dependency("googleauth", "~> 0.8")
+  spec.add_dependency("googleauth", "~> 1.2")
   spec.add_dependency("ejson", "~> 1.0")
   spec.add_dependency("colorize", "~> 0.8")
   spec.add_dependency("statsd-instrument", ['>= 2.8', "< 4"])

data/lib/krane/bindings_parser.rb

@@ -41,7 +41,8 @@ module Krane
         when '.json'
           bindings = parse_json(File.read(file_path))
         when '.yaml', '.yml'
-          bindings = YAML.safe_load(File.read(file_path), [], [], true, file_path)
+          bindings = YAML.safe_load(File.read(file_path), permitted_classes: [], permitted_symbols: [], 
+                                    aliases: true, filename: file_path)
         else
           raise ArgumentError, "Supplied file does not appear to be JSON or YAML"
         end

data/lib/krane/kubectl.rb

@@ -82,9 +82,17 @@ module Krane
     def version_info
       @version_info ||=
         begin
-          response, _, status = run("version", use_namespace: false, log_failure: true, attempts: 2)
+          response, _, status = run("version", output: "json", use_namespace: false, log_failure: true, attempts: 2)
           raise KubectlError, "Could not retrieve kubectl version info" unless status.success?
-          extract_version_info_from_kubectl_response(response)
+
+          version_data = JSON.parse(response)
+          client_version = platform_agnostic_version(version_data.dig("clientVersion", "gitVersion").to_s)
+          server_version = platform_agnostic_version(version_data.dig("serverVersion", "gitVersion").to_s)
+          unless client_version && server_version
+            raise KubectlError, "Received invalid kubectl version data: #{version_data}"
+          end
+
+          { client: client_version, server: server_version }
         end
     end
 
@@ -127,15 +135,10 @@ module Krane
       end
     end
 
-    def extract_version_info_from_kubectl_response(response)
-      info = {}
-      response.each_line do |l|
-        match = l.match(/^(?<kind>Client|Server).* GitVersion:"v(?<version>\d+\.\d+\.\d+)/)
-        if match
-          info[match[:kind].downcase.to_sym] = Gem::Version.new(match[:version])
-        end
+    def platform_agnostic_version(version_string)
+      if match = version_string.match(/v(?<version>\d+\.\d+\.\d+)/)
+        Gem::Version.new(match[:version])
       end
-      info
     end
   end
 end

data/lib/krane/kubernetes_resource/daemon_set.rb

@@ -9,7 +9,8 @@ module Krane
     def sync(cache)
       super
       @pods = exists? ? find_pods(cache) : []
-      @nodes = find_nodes(cache) if @nodes.blank?
+
+      @nodes = refresh_nodes(cache)
     end
 
     def status
@@ -58,7 +59,7 @@ module Krane
     def relevant_pods_ready?
       return true if rollout_data["desiredNumberScheduled"].to_i == rollout_data["numberReady"].to_i # all pods ready
       relevant_node_names = @nodes.map(&:name)
-      considered_pods = @pods.select { |p| relevant_node_names.include?(p.node_name) }
+      considered_pods = @pods.select { |p| relevant_node_names.include?(p.node_name) && !p.evicted? }
       @logger.debug("DaemonSet is reporting #{rollout_data['numberReady']} pods ready." \
         " Considered #{considered_pods.size} pods out of #{@pods.size} for #{@nodes.size} nodes.")
       considered_pods.present? &&
@@ -66,9 +67,24 @@ module Krane
         rollout_data["numberReady"].to_i >= considered_pods.length
     end
 
+    def refresh_nodes(cache)
+      new_nodes = find_nodes(cache)
+      return new_nodes if @nodes.blank?
+
+      # Remove non-existent nodes
+      @nodes.select do |node|
+        new_nodes.find { |n| n.name == node.name } != nil
+      end
+    end
+
     def find_nodes(cache)
       all_nodes = cache.get_all(Node.kind)
-      all_nodes.map { |node_data| Node.new(definition: node_data) }
+      all_nodes.each_with_object([]) do |node_data, relevant_nodes|
+        next if node_data.dig('spec', 'unschedulable').to_s.downcase == 'true'
+        cond = node_data.dig('status', 'conditions').find { |c| c['type'].downcase == 'ready' }
+        next if (!cond.nil? && cond['status'].downcase != 'true')
+        relevant_nodes << Node.new(definition: node_data)
+      end
     end
 
     def rollout_data

data/lib/krane/kubernetes_resource/pod.rb

@@ -105,6 +105,10 @@ module Krane
       @instance_data.dig('spec', 'nodeName')
     end
 
+    def evicted?
+      phase == "Failed" && reason == "Evicted"
+    end
+
     private
 
     def failed_schedule_reason
@@ -225,7 +229,11 @@ module Krane
         elsif limbo_reason == "ErrImagePull" && limbo_message.match(/not found/i)
           "Failed to pull image #{@image}. "\
           "Did you wait for it to be built and pushed to the registry before deploying?"
-        elsif limbo_reason == "CreateContainerConfigError"
+          # Only fail fast when message doesn't include `failed to sync %s cache`.
+          # It's possible that a secret/configmap is still trying to be mounted to the pod, it seems related
+          # to too many pods referencing the same secret/configmap: https://github.com/kubernetes/kubernetes/pull/74755
+          # Error message format source: https://github.com/kubernetes/kubernetes/pull/75260
+        elsif limbo_reason == "CreateContainerConfigError" && !limbo_message.match("failed to sync (.*?) cache")
           "Failed to generate container configuration: #{limbo_message}"
         elsif @status.dig("lastState", "terminated", "reason") == "ContainerCannotRun"
           # ref: https://github.com/kubernetes/kubernetes/blob/562e721ece8a16e05c7e7d6bdd6334c910733ab2/pkg/kubelet/dockershim/docker_container.go#L353

data/lib/krane/kubernetes_resource/stateful_set.rb

@@ -19,6 +19,9 @@ module Krane
     end
 
     def deploy_succeeded?
+      success = observed_generation == current_generation &&
+        desired_replicas == status_data['readyReplicas'].to_i &&
+        status_data['currentRevision'] == status_data['updateRevision']
       if update_strategy == ONDELETE
         # Gem cannot monitor update since it doesn't occur until delete
         unless @success_assumption_warning_shown
@@ -27,11 +30,10 @@ module Krane
                        "Consider switching to rollingUpdate.")
           @success_assumption_warning_shown = true
         end
+      else
+        success &= desired_replicas == status_data['currentReplicas'].to_i
       end
-      observed_generation == current_generation &&
-      status_data['currentRevision'] == status_data['updateRevision'] &&
-      desired_replicas == status_data['readyReplicas'].to_i &&
-      desired_replicas == status_data['currentReplicas'].to_i
+      success
     end
 
     def deploy_failed?

data/lib/krane/kubernetes_resource.rb

@@ -250,7 +250,7 @@ module Krane
     end
 
     def deploy_method_override
-      krane_annotation_value(DEPLOY_METHOD_OVERRIDE_ANNOTATION)&.to_sym
+      krane_annotation_value(DEPLOY_METHOD_OVERRIDE_ANNOTATION)&.gsub("-", "_")&.to_sym
     end
 
     def sync_debug_info(kubectl)

data/lib/krane/resource_deployer.rb

@@ -70,6 +70,7 @@ module Krane
             r.sync_debug_info(kubectl)
           end
           failed_resources.each { |r| logger.summary.add_paragraph(r.debug_message) }
+          raise DeploymentTimeoutError if failed_resources.all?(&:deploy_timed_out?)
           raise FatalDeploymentError, "Failed to deploy #{fail_count} priority #{'resource'.pluralize(fail_count)}"
         end
         logger.blank_line

data/lib/krane/restart_task.rb

@@ -213,7 +213,7 @@ module Krane
     def delete_statefulset_pods(record)
       pods = kubeclient.get_pods(namespace: record.metadata.namespace)
       pods.select! do |pod|
-        pod.metadata.ownerReferences.find { |ref| ref.uid == record.metadata.uid }
+        pod.metadata&.ownerReferences&.find { |ref| ref.uid == record.metadata.uid }
       end
       pods.each { |pod| kubeclient.delete_pod(pod.metadata.name, pod.metadata.namespace) }
     end

data/lib/krane/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: krane
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.9
 platform: ruby
 authors:
 - Katrina Verey
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,14 +46,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: ejson
   requirement: !ruby/object:Gem::Requirement
@@ -526,7 +526,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: A command line tool that helps you ship changes to a Kubernetes namespace