krane 2.3.5 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87de5ec387037d29595e3de534aa73e5aa492769c58dbfda3788d8b70fe76097
-  data.tar.gz: 3fbf5ea0bb33034f6ef4fad075628c144bbf6cffc73e8969617330c9d6705d95
+  metadata.gz: 93f7d9e842d616ea60e2c509f5e5a3fcb54d24375d426efd0345ba3a07dd2008
+  data.tar.gz: 24ccdd3165654319b55632a866f85839268644cb32ee719f55f03de6e5f63eb6
 SHA512:
-  metadata.gz: f24f15dc5733820c518c6636ddd2150c266166f836d366db72460e2a94dca3d81e52ea7e2ea2e143871bc2279f469ca1263cbb1993bad4c2ce972f3f57559c41
-  data.tar.gz: 0a49d8ea6a69b228991be2756ebbf93e2aa2c1b2f043aebb2f9a6b697b06c7eeb4ff5eab1ddfd3b40359e35e7ef5e73e8a6e8d9d8659c862bde0abbc8a218ee4
+  metadata.gz: 1c90430d28fe8513dd86aef6d160e04257beb66f294b998d780c66b27d8bdb7e5320947b06894399c49bcb336795f72a338fb197f3be4626467bfb286bbde2f0
+  data.tar.gz: 98fc07319ed605978d558777cea947a187bf3857d229b95945096d446fdbacd2637102e34a9e03afb9f5472105ce39d5d396f9c1cf8bc6f4c0677f28e6b88e9b

data/.github/workflows/ci.yml

@@ -11,24 +11,23 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-        - '3.0' # With k8s 1.23
-        - '3.0' # With k8s 1.22
-        - '3.0' # With k8s 1.21
+        # Use unique Ruby versions, or GitHub gets confused when building the rest of the matrix
+        - '3.0.3' # With k8s 1.23
+        - '3.0.2' # With k8s 1.22
+        - '3.0.1' # With k8s 1.21
         - '3.0' # With k8s 1.20
         - '2.7' # With k8s 1.19
-        - '2.6.6' # With k8s 1.18
-        - '2.6.6' # With k8s 1.17
         include:
         # Match kind images with chosen version https://github.com/kubernetes-sigs/kind/releases
-        - ruby: '3.0'
+        - ruby: '3.0.3'
           kind_version: 'v0.11.1'
           kubernetes_version: '1.23.0'
           kind_image: 'kindest/node:v1.23.0@sha256:49824ab1727c04e56a21a5d8372a402fcd32ea51ac96a2706a12af38934f81ac'
-        - ruby: '3.0'
+        - ruby: '3.0.2'
           kind_version: 'v0.11.1'
           kubernetes_version: '1.22.0'
           kind_image: 'kindest/node:v1.22.0@sha256:b8bda84bb3a190e6e028b1760d277454a72267a5454b57db34437c34a588d047'
-        - ruby: '3.0'
+        - ruby: '3.0.1'
           kind_version: 'v0.11.1'
           kubernetes_version: '1.21.1'
           kind_image: 'kindest/node:v1.21.1@sha256:69860bda5563ac81e3c0057d654b5253219618a22ec3a346306239bba8cfa1a6'
@@ -40,14 +39,6 @@ jobs:
           kind_version: 'v0.11.1'
           kubernetes_version: '1.19.11'
           kind_image: 'kindest/node:v1.19.11@sha256:07db187ae84b4b7de440a73886f008cf903fcf5764ba8106a9fd5243d6f32729'
-        - ruby: '2.6.6'
-          kind_version: 'v0.11.1'
-          kubernetes_version: '1.18.19'
-          kind_image: '1.18: kindest/node:v1.18.19@sha256:7af1492e19b3192a79f606e43c35fb741e520d195f96399284515f077b3b622c'
-        - ruby: '2.6.6'
-          kind_version: 'v0.11.1'
-          kubernetes_version: '1.17.17'
-          kind_image: 'kindest/node:v1.17.17@sha256:66f1d0d91a88b8a001811e2f1054af60eef3b669a9a74f9b6db871f2f1eeed00'
 
     steps:
       - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 ## next
 
+## 2.4.1
+
+*Enhancements*
+
+- Support restart task for stateful sets that use the `OnDelete` strategy [#840](https://github.com/Shopify/krane/pull/840)
+- Make `krane render` produce output in a deterministic order [#871](https://github.com/Shopify/krane/pull/871)
+
+*Other*
+
+- Remove buildkite [#869](https://github.com/Shopify/krane/pull/869)
+
+## 2.4.0
+
+*Enhancements*
+
+- Ensure deploy tasks fail without at least one non-empty resource [#865](https://github.com/Shopify/krane/issues/865)
+
+*Other*
+
+- Remove Ruby 2.6 and K8s < 1.19 from the CI testing matrix. All fixtures have been updated to be compatible with K8s 1.22+.
+
+## 2.3.7
+
+- isolated_execution_state active_support require for Rails 7+
+
+## 2.3.6
+
+- Update kubeclient for better Ruby 3.1 compatibility.
+
 ## 2.3.5
 
 - Psych 4 compatibility

data/README.md

@@ -73,24 +73,24 @@ If you need the ability to render dynamic values in templates before deploying,
 
 ## Prerequisites
 
-* Ruby 2.6+
-* Your cluster must be running Kubernetes v1.15.0 or higher<sup>1</sup>
+* Ruby 2.7+
+* Your cluster must be running Kubernetes v1.19.0 or higher<sup>1</sup>
 
 <sup>1</sup> We run integration tests against these Kubernetes versions. You can find our
 official compatibility chart below.
 
-| Kubernetes version | Last officially supported in gem version |
-| :----------------: | :-------------------: |
-|        1.5         |        0.11.2         |
-|        1.6         |        0.15.2         |
-|        1.7         |        0.20.6         |
-|        1.8         |        0.21.1         |
-|        1.9         |        0.24.0         |
-|        1.10        |        0.27.0         |
+| Kubernetes version | Currently Tested? | Last officially supported in gem version |
+|:------------------:|-------------------|:----------------------------------------:|
+|        1.18        | No                |                  2.3.7                   |
+|        1.19        | Yes               |                    --                    |
+|        1.20        | Yes               |                    --                    |
+|        1.21        | Yes               |                    --                    |
+|        1.22        | Yes               |                    --                    |
+|        1.23        | Yes               |                    --                    |
 
 ## Installation
 
-1. [Install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl-binary-via-curl) (requires v1.15.0 or higher) and make sure it is available in your $PATH
+1. [Install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl-binary-via-curl) (requires v1.19.0 or higher) and make sure it is available in your $PATH
 2. Set up your [kubeconfig file](https://kubernetes.io/docs/tasks/access-application-cluster/authenticate-across-clusters-kubeconfig/) for access to your cluster(s).
 3. `gem install krane`
 

data/dev.yml

@@ -1,7 +1,7 @@
 ---
 name: krane
 up:
-  - ruby: 2.6.6 # Matches gemspec
+  - ruby: '3.0.3' # Matches gemspec
   - bundler
   - custom:
       name: Install Kubernetes in Docker (KinD)
@@ -13,7 +13,7 @@ up:
   - custom:
       name: Create KinD Cluster
       met?: bin/kind get clusters | grep -q krane
-      meet: bin/kind create cluster --name 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
 commands:

data/krane.gemspec

@@ -27,14 +27,14 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6.0'
   spec.add_dependency("activesupport", ">= 5.0")
-  spec.add_dependency("kubeclient", "~> 4.3")
+  spec.add_dependency("kubeclient", "~> 4.9")
   spec.add_dependency("googleauth", "~> 0.8")
   spec.add_dependency("ejson", "~> 1.0")
   spec.add_dependency("colorize", "~> 0.8")
   spec.add_dependency("statsd-instrument", ['>= 2.8', "< 4"])
   spec.add_dependency("oj", "~> 3.0")
   spec.add_dependency("concurrent-ruby", "~> 1.1")
-  spec.add_dependency("jsonpath", "~> 0.9.6")
+  spec.add_dependency("jsonpath", "~> 1.0")
   spec.add_dependency("thor", ">= 1.0", "< 2.0")
 
   # Basics

data/lib/krane/common.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support'
+require 'active_support/isolated_execution_state' if ActiveSupport::VERSION::MAJOR > 6
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/hash/slice'

data/lib/krane/deploy_task.rb

@@ -254,6 +254,10 @@ module Krane
 
       StatsD.client.gauge('discover_resources.count', resources.size, tags: statsd_tags)
 
+      if resources.empty?
+        raise FatalDeploymentError, "No deployable resources were found!"
+      end
+
       resources.sort
     rescue InvalidTemplateError => e
       record_invalid_template(logger: @logger, err: e.message, filename: e.filename,

data/lib/krane/kubernetes_resource/custom_resource_definition.rb

@@ -37,7 +37,10 @@ module Krane
 
     def group_version_kind
       group = @definition.dig("spec", "group")
-      version = @definition.dig("spec", "version")
+      # Since 1.22: spec.version is removed in v1; use spec.versions instead.
+      # New spec here: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#create-a-customresourcedefinition
+      # This is only used in testing, so we will simply take the first version we see:
+      version = @definition.dig("spec", "versions", 0, "name")
       "#{group}/#{version}/#{kind}"
     end
 

data/lib/krane/kubernetes_resource/mutating_webhook_configuration.rb

@@ -48,6 +48,7 @@ module Krane
       end
 
       def has_side_effects?
+        # Note: After K8s 1.22, this should ALWAYS be false.
         !%w(None NoneOnDryRun).include?(side_effects)
       end
 

data/lib/krane/kubernetes_resource/stateful_set.rb

@@ -27,13 +27,11 @@ module Krane
                        "Consider switching to rollingUpdate.")
           @success_assumption_warning_shown = true
         end
-        true
-      else
-        observed_generation == current_generation &&
-        status_data['currentRevision'] == status_data['updateRevision'] &&
-        desired_replicas == status_data['readyReplicas'].to_i &&
-        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
     end
 
     def deploy_failed?

data/lib/krane/restart_task.rb

@@ -69,10 +69,10 @@ module Krane
       deployments, statefulsets, daemonsets = identify_target_workloads(deployments, statefulsets,
                                                 daemonsets, selector: selector)
 
-      @logger.phase_heading("Triggering restart by annotating pod template #{RESTART_TRIGGER_ANNOTATION} annotation")
-      patch_kubeclient_deployments(deployments)
-      patch_kubeclient_statefulsets(statefulsets)
-      patch_kubeclient_daemonsets(daemonsets)
+      @logger.phase_heading("Triggering restart")
+      restart_deployments!(deployments)
+      restart_statefulsets!(statefulsets)
+      restart_daemonsets!(daemonsets)
 
       if verify_result
         @logger.phase_heading("Waiting for rollout")
@@ -210,7 +210,15 @@ module Krane
       apps_v1_kubeclient.patch_daemon_set(record.metadata.name, build_patch_payload(record), @namespace)
     end
 
-    def patch_kubeclient_deployments(deployments)
+    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 }
+      end
+      pods.each { |pod| kubeclient.delete_pod(pod.metadata.name, pod.metadata.namespace) }
+    end
+
+    def restart_deployments!(deployments)
       deployments.each do |record|
         begin
           patch_deployment_with_restart(record)
@@ -221,18 +229,23 @@ module Krane
       end
     end
 
-    def patch_kubeclient_statefulsets(statefulsets)
+    def restart_statefulsets!(statefulsets)
       statefulsets.each do |record|
-        begin
+        @logger.info("Triggered `StatefulSet/#{record.metadata.name}` restart")
+        if record.spec.updateStrategy&.type == "OnDelete"
+          @logger.info("`StatefulSet/#{record.metadata.name}` has updateStrategy: OnDelete," \
+            " Restarting by forcefully deleting child pods"
+          )
+          delete_statefulset_pods(record)
+        else
           patch_statefulset_with_restart(record)
-          @logger.info("Triggered `StatefulSet/#{record.metadata.name}` restart")
-        rescue Kubeclient::HttpError => e
-          raise RestartAPIError.new(record.metadata.name, e.message)
         end
+      rescue Kubeclient::HttpError => e
+        raise RestartAPIError.new(record.metadata.name, e.message)
       end
     end
 
-    def patch_kubeclient_daemonsets(daemonsets)
+    def restart_daemonsets!(daemonsets)
       daemonsets.each do |record|
         begin
           patch_daemonset_with_restart(record)

data/lib/krane/template_sets.rb

@@ -104,11 +104,11 @@ module Krane
         dir_paths.each do |template_dir|
           resource_templates[template_dir] = Dir.foreach(template_dir).select do |filename|
             filename.end_with?(*VALID_TEMPLATES) || filename == EjsonSecretProvisioner::EJSON_SECRETS_FILE
-          end
+          end.sort
         end
 
         # Filename paths
-        file_paths.each do |filename|
+        file_paths.sort.each do |filename|
           dir_name = File.dirname(filename)
           resource_templates[dir_name] ||= []
           resource_templates[dir_name] << File.basename(filename) unless resource_templates[dir_name].include?(filename)

data/lib/krane/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: krane
 version: !ruby/object:Gem::Version
-  version: 2.3.5
+  version: 2.4.1
 platform: ruby
 authors:
 - Katrina Verey
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.9'
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
@@ -136,14 +136,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -411,7 +411,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".buildkite/pipeline.nightly.yml"
 - ".github/CODEOWNERS"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/probots.yml"

data/.buildkite/pipeline.nightly.yml

@@ -1,15 +0,0 @@
-steps:
-  - name: 'Run Test Suite (:kubernetes: 1.16-latest)'
-    command: bin/ci
-    agents:
-      queue: k8s-ci
-    env:
-      LOGGING_LEVEL: 4
-      KUBERNETES_VERSION: v1.16-latest
-  - name: 'Run Test Suite (:kubernetes: 1.15-latest)'
-    command: bin/ci
-    agents:
-      queue: k8s-ci
-    env:
-      LOGGING_LEVEL: 4
-      KUBERNETES_VERSION: v1.15-latest