krane 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3897a03c881bd2998b2f41d2132e5bfefd706c04377b37181799f39e3db6bc28
-  data.tar.gz: 33358538717dac791c972003ed22a0c4ca5fa639db04110ee86b5a2c5b8ffa15
+  metadata.gz: ea6e5f5541819d9404729a0c1f05aae53c4d909817c73349aab761987ea0b368
+  data.tar.gz: '049f3b4cd88f914580475b84e33f3bd216f363f6b5474dd76810ce53f051d4e0'
 SHA512:
-  metadata.gz: 20b73fc4a7766307ec90e2b9354893834b01d1b0e26ed105e583cbc108ffe6fbf3ab1138900f0cd0a1d673a199c6a6ea72d6360e8af6ed7cdf6fd9854b809e74
-  data.tar.gz: 2234d0c9465f27c36cf045c721e7387e4b6e3f67052bf1560a932869c07bab9bd0c3c5fe6b60290549e2a08ccf06444ca30cc592e2e8c22310ea0fe515e08e84
+  metadata.gz: b860d42eb86ff04e44faf2709ff98c31cc60a2c0c1418088dff894cadcda8b9c85400a17e3db1946211996bd5389bde75d0efc5bb75d12231b6977b89ff23753
+  data.tar.gz: 4345f565b49788844df7ac55978237192990de8689a55cc76b1d48e54aa69fb1ae3f93869d1760a606a9d6d3a3c0c3521d0eef77da414122c6b3b594204f0379

data/.github/workflows/ci.yml

@@ -11,17 +11,21 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - "3.2.2"
           - "3.1.2"
           - "3.0.4"
           - "2.7.6"
         kubernetes_version:
-          - "1.24.6"
-          - "1.23.12"
+          - "1.26.4"
+          - "1.24.13"
+          - "1.23.17"
         include:
-          - kubernetes_version: "1.24.6"
-            kind_image: "kindest/node:v1.24.6@sha256:97e8d00bc37a7598a0b32d1fabd155a96355c49fa0d4d4790aab0f161bf31be1"
-          - kubernetes_version: "1.23.12"
-            kind_image: "kindest/node:v1.23.12@sha256:9402cf1330bbd3a0d097d2033fa489b2abe40d479cc5ef47d0b6a6960613148a"
+          - kubernetes_version: "1.26.4"
+            kind_image: "kindest/node:v1.26.4@sha256:a539833d26264444ab3b8f5e56e23fa3361436445fa23c864e6dec622458858f"
+          - kubernetes_version: "1.24.13"
+            kind_image: "kindest/node:v1.24.13@sha256:c9e00e2b228e47ba3c96eaf0309b27dc3f73e444944e4c900016fd07b1b805cb"
+          - kubernetes_version: "1.23.17"
+            kind_image: "kindest/node:v1.23.17@sha256:eb33093b461ffee7614ca65a39ac0fb57982e1407dc38df4df92811c4fbcb687"
 
     steps:
       - uses: actions/checkout@v3

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## next
 
+## 3.3.0
+
+*Enhancements*
+
+- Enable detection of successful StatefulSet deploys when the `updateStrategy` is `onDelete`, behind an annotation. [#926](https://github.com/Shopify/krane/pull/926)
+
+## 3.2.0
+
+*Enhancements*
+
+- Test against k8s 1.26
+
 ## 3.1.0
 
 *Enhancements*

data/README.md

@@ -92,6 +92,7 @@ Krane provides support for official upstream supported versions [Kubernetes](htt
 |        1.23        | Yes               |                    --                    |
 |        1.24        | Yes               |                    --                    |
 |        1.25        | No                |                    --                    |
+|        1.26        | Yes               |                    --                    |
 
 ## Installation
 
@@ -154,14 +155,13 @@ If you want dynamic templates, you may render ERB with `krane render` and then p
 - `krane.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.
-  - Percent (e.g. 90%): The deploy is successful when the number of new pods that are ready is equal to
-  `spec.replicas` * Percent.
+    - `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.
+    - Percent (e.g. 90%): The deploy is successful when the number of new pods that are ready is equal to `spec.replicas` * Percent.
+  - _Compatibility_: StatefulSet
+    - `full`: The deployment is successful when all pods are ready.
 - `krane.shopify.io/predeployed`: Causes a Custom Resource to be deployed in the pre-deploy phase.
   - _Compatibility_: Custom Resource Definition
   - _Default_: `true`
@@ -303,7 +303,7 @@ As an example, the following is the default configuration that will be used if y
 }'
 ```
 
-The paths defined here are based on the [typical status properties](https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#typical-status-properties) as defined by the Kubernetes community. It expects the `status` subresource to contain a `conditions` array whose entries minimally specify `type`, `status`, and `message` fields.
+The paths defined here are based on the [typical status properties](https://github.com/kubernetes/community/blob/0e9fa4a1c45203527a7ce35eaff09204d6b7b331/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties) as defined by the Kubernetes community. It expects the `status` subresource to contain a `conditions` array whose entries minimally specify `type`, `status`, and `message` fields.
 
 You can see how these conditions relate to the following resource:
 
@@ -592,7 +592,7 @@ Inside a partial, parameters can be accessed as normal variables, or via a hash
 
 ```yaml
 ---
-apiVersion: batch/v1beta1
+apiVersion: batch/v1
 kind: CronJob
 metadata:
   name: cron-<%= name %>

data/bin/test

@@ -23,7 +23,7 @@ if [[ ${PARALLELISM:=0} -lt 1 ]]; then
   if [[ $num_cpus -le 2 ]]; then
     PARALLELISM=1
   else
-    (( PARALLELISM=num_cpus/2 ))
+    (( PARALLELISM=num_cpus ))
   fi
 fi
 

data/dev.yml

@@ -1,12 +1,12 @@
 ---
 name: krane
 up:
-  - ruby: '3.1.2' # Matches gemspec
+  - ruby: '3.2.2' # Matches gemspec
   - bundler
   - podman
   - kind:
       name: krane
-      image: kindest/node:v1.24.6@sha256:97e8d00bc37a7598a0b32d1fabd155a96355c49fa0d4d4790aab0f161bf31be1
+      image: kindest/node:v1.26.4@sha256:354b7b57f16dc42d5ccc8c7eb3c3c8b3818531d35bc82600ba874a85fa1fa28a
 commands:
   test:
     run: bin/test

data/krane.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   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("multi_json")
   spec.add_dependency("concurrent-ruby", "~> 1.1")
   spec.add_dependency("jsonpath", "~> 1.0")
   spec.add_dependency("thor", ">= 1.0", "< 2.0")
@@ -43,11 +43,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency("yard")
 
   # Test framework
-  spec.add_development_dependency("minitest", "~> 5.12")
+  spec.add_development_dependency("minitest", "~> 5.19")
   spec.add_development_dependency("minitest-stub-const", "~> 0.6")
   spec.add_development_dependency("minitest-reporters")
-  spec.add_development_dependency("mocha", "~> 1.5")
-  spec.add_development_dependency("webmock", "~> 3.0")
+  spec.add_development_dependency("mocha", "~> 2.1")
+  spec.add_development_dependency("webmock", "~> 3.18")
   spec.add_development_dependency("timecop")
 
   # Debugging and analysis

data/lib/krane/bindings_parser.rb

@@ -54,14 +54,14 @@ module Krane
     end
 
     def parse_json(string)
-      bindings = JSON.parse(string)
+      bindings = MultiJson.load(string)
 
       unless bindings.is_a?(Hash)
         raise ArgumentError, "Expected JSON data to be a hash."
       end
 
       bindings
-    rescue JSON::ParserError
+    rescue MultiJson::ParseError
       nil
     end
 

data/lib/krane/cli/krane.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 require 'krane'
-require 'krane/oj'
-require 'thor'
-require 'krane/cli/version_command'
-require 'krane/cli/restart_command'
-require 'krane/cli/run_command'
-require 'krane/cli/render_command'
 require 'krane/cli/deploy_command'
 require 'krane/cli/global_deploy_command'
+require 'krane/cli/render_command'
+require 'krane/cli/restart_command'
+require 'krane/cli/run_command'
+require 'krane/cli/version_command'
+require 'multi_json'
+require 'thor'
 
 module Krane
   module CLI

data/lib/krane/cluster_resource_discovery.rb

@@ -54,7 +54,7 @@ module Krane
       @api_path_cache["/"] ||= begin
         raw_json, err, st = kubectl.run("get", "--raw", base_api_path, attempts: 5, use_namespace: false)
         paths = if st.success?
-          JSON.parse(raw_json)["paths"]
+          MultiJson.load(raw_json)["paths"]
         else
           raise FatalKubeAPIError, "Error retrieving raw path /: #{err}"
         end
@@ -66,7 +66,7 @@ module Krane
       @api_path_cache[path] ||= begin
         raw_json, err, st = kubectl.run("get", "--raw", path, attempts: 2, use_namespace: false)
         if st.success?
-          JSON.parse(raw_json)
+          MultiJson.load(raw_json)
         else
           logger.warn("Error retrieving api path: #{err}")
           {}
@@ -92,7 +92,7 @@ module Krane
       raw_json, err, st = kubectl.run("get", "CustomResourceDefinition", output: "json", attempts: 5,
         use_namespace: false)
       if st.success?
-        JSON.parse(raw_json)["items"]
+        MultiJson.load(raw_json)["items"]
       else
         raise FatalKubeAPIError, "Error retrieving CustomResourceDefinition: #{err}"
       end

data/lib/krane/deploy_task.rb

@@ -288,7 +288,6 @@ module Krane
       validate_globals(resources)
       batch_dry_run_success = validate_dry_run(resources)
       resources.select! { |r| r.selected?(@selector) } if @selector_as_filter
-
       Krane::Concurrency.split_across_threads(resources) do |r|
         # No need to pass in kubectl (and do per-resource dry run apply) if batch dry run succeeded
         if batch_dry_run_success
@@ -329,7 +328,7 @@ module Krane
       @namespace_definition ||= begin
         definition, _err, st = kubectl.run("get", "namespace", @namespace, use_namespace: false,
           log_failure: true, raise_if_not_found: true, attempts: 3, output: 'json')
-        st.success? ? JSON.parse(definition, symbolize_names: true) : nil
+        st.success? ? MultiJson.load(definition, symbolize_names: true) : nil
       end
     rescue Kubectl::ResourceNotFoundError
       nil
@@ -363,7 +362,7 @@ module Krane
         unless st.success?
           raise EjsonSecretError, "Error retrieving Secret/#{EjsonSecretProvisioner::EJSON_KEYS_SECRET}: #{err}"
         end
-        JSON.parse(out)
+        MultiJson.load(out)
       end
     end
 

data/lib/krane/ejson_secret_provisioner.rb

@@ -117,8 +117,8 @@ module Krane
 
     def load_ejson_from_file
       return {} unless File.exist?(@ejson_file)
-      JSON.parse(File.read(@ejson_file))
-    rescue JSON::ParserError => e
+      MultiJson.load(File.read(@ejson_file))
+    rescue MultiJson::ParseError => e
       raise EjsonSecretError, "Failed to parse encrypted ejson:\n  #{e}"
     end
 
@@ -139,8 +139,8 @@ module Krane
         msg = err.presence || out
         raise EjsonSecretError, msg
       end
-      JSON.parse(out)
-    rescue JSON::ParserError
+      MultiJson.load(out)
+    rescue MultiJson::ParseError
       raise EjsonSecretError, "Failed to parse decrypted ejson"
     end
 

data/lib/krane/kubeclient_builder.rb

@@ -49,9 +49,9 @@ module Krane
       )
     end
 
-    def build_policy_v1beta1_kubeclient(context)
+    def build_policy_v1_kubeclient(context)
       build_kubeclient(
-        api_version: "v1beta1",
+        api_version: "v1",
         context: context,
         endpoint_path: "/apis/policy/"
       )

data/lib/krane/kubectl.rb

@@ -85,7 +85,7 @@ module Krane
           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?
 
-          version_data = JSON.parse(response)
+          version_data = MultiJson.load(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

data/lib/krane/kubernetes_resource/pod.rb

@@ -10,6 +10,7 @@ module Krane
     )
 
     attr_accessor :stream_logs
+    attr_reader :definition
 
     def initialize(namespace:, context:, definition:, logger:,
       statsd_tags: nil, parent: nil, deploy_started_at: nil, stream_logs: false)

data/lib/krane/kubernetes_resource/stateful_set.rb

@@ -5,6 +5,7 @@ module Krane
     TIMEOUT = 10.minutes
     ONDELETE = 'OnDelete'
     SYNC_DEPENDENCIES = %w(Pod)
+    REQUIRED_ROLLOUT_TYPES = %w(full).freeze
     attr_reader :pods
 
     def sync(cache)
@@ -19,25 +20,35 @@ 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
+      success = observed_generation == current_generation
+
+      @pods.each do |pod|
+        success &= pod.definition["metadata"]["labels"]["controller-revision-hash"] == status_data['updateRevision']
+      end
+
+      if update_strategy == 'RollingUpdate'
+        success &= status_data['currentRevision'] == status_data['updateRevision']
+        success &= desired_replicas == status_data['readyReplicas'].to_i
+        success &= desired_replicas == status_data['currentReplicas'].to_i
+
+      elsif update_strategy == ONDELETE
         unless @success_assumption_warning_shown
           @logger.warn("WARNING: Your StatefulSet's updateStrategy is set to OnDelete, "\
-                       "which means updates will not be applied until its pods are deleted. "\
-                       "Consider switching to rollingUpdate.")
+                       "which means the deployment won't succeed until all pods are updated by deletion.")
           @success_assumption_warning_shown = true
         end
-      else
-        success &= desired_replicas == status_data['currentReplicas'].to_i
+
+        if required_rollout == 'full'
+          success &= desired_replicas == status_data['readyReplicas'].to_i
+          success &= desired_replicas == status_data['updatedReplicas'].to_i
+        end
       end
+
       success
     end
 
     def deploy_failed?
-      return false if update_strategy == ONDELETE
+      return false if update_strategy == ONDELETE && required_rollout != 'full'
       pods.present? && pods.any?(&:deploy_failed?) &&
       observed_generation == current_generation
     end
@@ -67,5 +78,9 @@ module Krane
       pod_data["metadata"]["ownerReferences"].any? { |ref| ref["uid"] == @instance_data["metadata"]["uid"] } &&
       @instance_data["status"]["currentRevision"] == pod_data["metadata"]["labels"]["controller-revision-hash"]
     end
+
+    def required_rollout
+      krane_annotation_value("required-rollout") || nil
+    end
   end
 end

data/lib/krane/kubernetes_resource.rb

@@ -553,7 +553,6 @@ module Krane
       if err.empty? || err.match(SERVER_DRY_RUN_DISABLED_ERROR)
         _, err, st = validate_with_local_dry_run(kubectl)
       end
-
       return true if st.success?
       @validation_errors << if sensitive_template_content?
         "Validation for #{id} failed. Detailed information is unavailable as the raw error may contain sensitive data."
@@ -576,7 +575,6 @@ module Krane
     def validate_with_local_dry_run(kubectl)
       verb = deploy_method == :apply ? "apply" : "create"
       command = [verb, "-f", file_path, "--dry-run=client", "--output=name"]
-
       kubectl.run(*command, log_failure: false, output_is_sensitive: sensitive_template_content?,
         retry_whitelist: [:client_timeout, :empty, :context_deadline], attempts: 3, use_namespace: !global?)
     end

data/lib/krane/resource_cache.rb

@@ -64,7 +64,7 @@ module Krane
       raise KubectlError unless st.success?
 
       instances = {}
-      JSON.parse(raw_json)["items"].each do |resource|
+      MultiJson.load(raw_json)["items"].each do |resource|
         resource_name = resource.dig("metadata", "name")
         instances[resource_name] = resource
       end

data/lib/krane/resource_deployer.rb

@@ -252,7 +252,7 @@ module Krane
       # For resources that rely on a generateName attribute, we get the `name` from the result of the call to `create`
       # We must explicitly set this name value so that the `apply` step for pruning can run successfully
       if status.success? && resource.uses_generate_name?
-        resource.use_generated_name(JSON.parse(out))
+        resource.use_generated_name(MultiJson.load(out))
       end
 
       [err, status]

data/lib/krane/rollout_conditions.rb

@@ -11,7 +11,7 @@ module Krane
       def from_annotation(conditions_string)
         return new(default_conditions) if conditions_string.downcase.strip == "true"
 
-        conditions = JSON.parse(conditions_string).slice('success_conditions', 'failure_conditions')
+        conditions = MultiJson.load(conditions_string).slice('success_conditions', 'failure_conditions')
         conditions.deep_symbolize_keys!
 
         # Create JsonPath objects
@@ -26,7 +26,7 @@ module Krane
         end
 
         new(conditions)
-      rescue JSON::ParserError => e
+      rescue MultiJson::ParseError => e
         raise RolloutConditionsError, "Rollout conditions are not valid JSON: #{e}"
       rescue StandardError => e
         raise RolloutConditionsError,

data/lib/krane/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: krane
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Katrina Verey
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-11 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,19 +103,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.12'
+        version: '5.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.12'
+        version: '5.19'
 - !ruby/object:Gem::Dependency
   name: minitest-stub-const
   requirement: !ruby/object:Gem::Requirement
@@ -254,28 +254,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.18'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -487,7 +487,6 @@ files:
 - lib/krane/kubernetes_resource/service_account.rb
 - lib/krane/kubernetes_resource/stateful_set.rb
 - lib/krane/label_selector.rb
-- lib/krane/oj.rb
 - lib/krane/options_helper.rb
 - lib/krane/psych_k8s_compatibility.rb
 - lib/krane/remote_logs.rb
@@ -525,7 +524,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: A command line tool that helps you ship changes to a Kubernetes namespace

data/lib/krane/oj.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-require 'oj'
-
-Oj.mimic_JSON