krane 3.6.2 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba72a52b848777243b9335d8df21f98080fcf49142706c2443bf40475d071b5f
-  data.tar.gz: 4f1a17c291e5ef38847f7a083cc1d6dcc00262c0dd447a39b7c39ab044268142
+  metadata.gz: 034cf54d143695589902632153ddb65969bae6135c88b076ec023c3c7dc3264a
+  data.tar.gz: 309a1d3c9cf5afad784f48a12d9fe1b13568f1485aec95b0007739a13973932a
 SHA512:
-  metadata.gz: fdae1d679008ec4de4ee83c2f1925f7b168456189f824face6b3d3f7079bdda89c25bea6da676ab95508cc5ce125587863e8af307a6f6d3814dc75b029280d56
-  data.tar.gz: 603e6f890a482b0e549ed9b1c0deca4ae3e4bb73144c7174f2a430c964127ee4cd75d516eb4e7561258afac29c711f5b595c3cc35316cf4c9e05a6a1aeab9bf0
+  metadata.gz: 44e89c3a956dec061b554f17a38a2e7afc552cf94a5071470baa3f60fb16ae2510f287d9dd8c2f9e9cc92d78fc330be225de62ce43c3be9bb22eab06104076c4
+  data.tar.gz: c9d79cd30d415ea7dc718541921a9c02cb60712fe2d021e22869bb03c0e7608b918f8c285a0362fe19d709780c8c48d4f3b5a3c6ba7fa34d299613421350722a

data/.github/workflows/ci.yml

@@ -18,6 +18,7 @@ jobs:
           - "3.0.4"
           - "2.7.6"
         kubernetes_version:
+          - "1.31.2"
           - "1.30.0"
           - "1.29.4"
           - "1.28.0"
@@ -29,6 +30,8 @@ jobs:
           - "serial_integration_test"
           - "integration_test"
         include:
+          - kubernetes_version: "1.31.2"
+            kind_image: "kindest/node:v1.31.2@sha256:18fbefc20a7113353c7b75b5c869d7145a6abd6269154825872dc59c1329912e"
           - kubernetes_version: "1.30.0"
             kind_image: "kindest/node:v1.30.0@sha256:047357ac0cfea04663786a612ba1eaba9702bef25227a794b52890dd8bcd692e"
           - kubernetes_version: "1.29.4"

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## next
 
+## 3.7.1
+
+- Add a `--partials-dir` parameter. When provided, this path will be check for partials first, prior to both `./partials` and `../partials` being checked.
+
+## 3.7.0
+
+- Annotate individual resources with `last-applied-configuration` when using `krane deploy` with `--annotate-individuals`. Previously, eligible resources that were made with `create` or `replace` were applied along with the rest of the resources. However, this causes issues when a mutating admission controller modifies otherwise immutable fields.
+
+## 3.6.3
+
+- Test against k8s 1.31
+
 ## 3.6.2
 
 - Pinning `stats-instrument` to < 3.9 to avoid breaking changes.
@@ -8,7 +20,7 @@
 
 *Features*
 
-- Enable the option to bypass endpoint validation for a service by using the annotation `krane.shopify.io/skip-endpoint-validation: true`. 
+- Enable the option to bypass endpoint validation for a service by using the annotation `krane.shopify.io/skip-endpoint-validation: true`.
 
 ## 3.6.0
 

data/README.md

@@ -97,6 +97,7 @@ Krane provides support for official upstream supported versions [Kubernetes](htt
 |        1.28        | Yes               |                    --                    |
 |        1.29        | Yes               |                    --                    |
 |        1.30        | Yes               |                    --                    |
+|        1.31        | Yes               |                    --                    |
 
 ## Installation
 

data/dev.yml

@@ -6,7 +6,7 @@ up:
   - podman
   - kind:
       name: krane
-      image: kindest/node:v1.28.0@sha256:dad5a6238c5e41d7cac405fae3b5eda2ad1de6f1190fa8bfc64ff5bb86173213
+      image: kindest/node:v1.31.2@sha256:18fbefc20a7113353c7b75b5c869d7145a6abd6269154825872dc59c1329912e
 commands:
   test:
     run: bin/test unit_test && bin/test cli_test && bin/test serial_integration_test && bin/test integration_test

data/lib/krane/cli/render_command.rb

@@ -11,6 +11,8 @@ module Krane
                      desc: "[DEPRECATED] Read resources from stdin" },
         "current-sha" => { type: :string, banner: "SHA", desc: "Expose SHA `current_sha` in ERB bindings",
                            lazy_default: '' },
+        "partials-dir" => { type: :string, banner: "partials", required:false, default: nil,
+                            desc: "First directory to look for partials, before checking `./partials` and `../partials`" },
       }
 
       def self.from_options(options)
@@ -32,6 +34,7 @@ module Krane
             current_sha: options['current-sha'],
             filenames: paths,
             bindings: bindings_parser.parse,
+            partials_dir: options['partials-dir'],
           )
           renderer.run!(stream: STDOUT)
         end

data/lib/krane/render_task.rb

@@ -14,11 +14,13 @@ module Krane
     # @param current_sha [String] The SHA of the commit
     # @param filenames [Array<String>] An array of filenames and/or directories containing templates (*required*)
     # @param bindings [Hash] Bindings parsed by Krane::BindingsParser
-    def initialize(logger: nil, current_sha:, filenames: [], bindings:)
+    # @params partials_dir [String] A directory to look for partials, before checking `./partials` and `../partials`
+    def initialize(logger: nil, current_sha:, filenames: [], bindings:, partials_dir: nil)
       @logger = logger || Krane::FormattedLogger.build
       @filenames = filenames.map { |path| File.expand_path(path) }
       @bindings = bindings
       @current_sha = current_sha
+      @partials_dir = partials_dir
     end
 
     # Runs the task, returning a boolean representing success or failure
@@ -58,7 +60,7 @@ module Krane
       @logger.phase_heading("Rendering template(s)")
       count = 0
       template_sets.with_resource_definitions_and_filename(current_sha: @current_sha,
-        bindings: @bindings, raw: true) do |rendered_content, filename|
+        bindings: @bindings, raw: true, partials_dir: @partials_dir) do |rendered_content, filename|
         write_to_stream(rendered_content, filename, stream)
         count += 1
       end

data/lib/krane/renderer.rb

@@ -16,11 +16,14 @@ module Krane
     end
     class PartialNotFound < InvalidTemplateError; end
 
-    def initialize(current_sha:, template_dir:, logger:, bindings: {})
+    def initialize(current_sha:, template_dir:, logger:, bindings: {}, partials_dir: nil)
       @current_sha = current_sha
       @template_dir = template_dir
       @partials_dirs =
         %w(partials ../partials).map { |d| File.expand_path(File.join(@template_dir, d)) }
+      # Prepend the partial_dir to the list of partials_dirs so that the user-provided
+      # directory is used first.
+      @partials_dirs.unshift(File.expand_path(partials_dir)) if partials_dir
       @logger = logger
       @bindings = bindings
       # Max length of podname is only 63chars so try to save some room by truncating sha to 8 chars

data/lib/krane/resource_deployer.rb

@@ -22,7 +22,7 @@ module Krane
 
     def deploy!(resources, verify_result, prune)
       if verify_result
-        deploy_all_resources(resources, prune: prune, verify: true)
+        deploy_all_resources(resources, prune: prune, verify: true, annotate_individuals: true)
         failed_resources = resources.reject(&:deploy_succeeded?)
         success = failed_resources.empty?
         if !success && failed_resources.all?(&:deploy_timed_out?)
@@ -30,7 +30,7 @@ module Krane
         end
         raise FatalDeploymentError unless success
       else
-        deploy_all_resources(resources, prune: prune, verify: false)
+        deploy_all_resources(resources, prune: prune, verify: false, annotate_individuals: true)
         logger.summary.add_action("deployed #{resources.length} #{'resource'.pluralize(resources.length)}")
         warning = <<~MSG
           Deploy result verification is disabled for this deploy.
@@ -73,12 +73,13 @@ module Krane
 
     private
 
-    def deploy_all_resources(resources, prune: false, verify:, record_summary: true)
-      deploy_resources(resources, prune: prune, verify: verify, record_summary: record_summary)
+    def deploy_all_resources(resources, prune: false, verify:, record_summary: true, annotate_individuals: false)
+      deploy_resources(resources, prune: prune, verify: verify, record_summary: record_summary,
+      annotate_individuals: annotate_individuals)
     end
     measure_method(:deploy_all_resources, 'normal_resources.duration')
 
-    def deploy_resources(resources, prune: false, verify:, record_summary: true)
+    def deploy_resources(resources, prune: false, verify:, record_summary: true, annotate_individuals: false)
       return if resources.empty?
       deploy_started_at = Time.now.utc
 
@@ -96,7 +97,6 @@ module Krane
       applyables, individuals = resources.partition { |r| r.deploy_method == :apply }
       # Prunable resources should also applied so that they can  be pruned
       pruneable_types = @prune_allowlist.map { |t| t.split("/").last }
-      applyables += individuals.select { |r| pruneable_types.include?(r.type) && !r.deploy_method_override }
 
       individuals.each do |individual_resource|
         individual_resource.deploy_started_at = Time.now.utc
@@ -122,6 +122,11 @@ module Krane
 
       apply_all(applyables, prune)
 
+      if annotate_individuals
+        to_annotate = individuals.select { |r| pruneable_types.include?(r.type) && !r.deploy_method_override }
+        update_last_applied_annotations(to_annotate)
+      end
+
       if verify
         watcher = Krane::ResourceWatcher.new(resources: resources, deploy_started_at: deploy_started_at,
           timeout: @global_timeout, task_config: @task_config, sha: @current_sha)
@@ -252,6 +257,19 @@ module Krane
       [err, status]
     end
 
+    def update_last_applied_annotations(resources)
+      resources.each do |resource|
+        err, status = set_last_applied_annotation(resource)
+        raise FatalDeploymentError, "Failed to set last applied annotation: #{err}" unless status.success?
+      end
+    end
+
+    def set_last_applied_annotation(resource)
+      _, err, status = kubectl.run("apply", "set-last-applied", "--create-annotation", "-f", resource.file_path, log_failure: false,
+        output_is_sensitive: resource.sensitive_template_content?, use_namespace: !resource.global?)
+      [err, status]
+    end
+
     # Inspect the file referenced in the kubectl stderr
     # to make it easier for developer to understand what's going on
     def find_bad_files_from_kubectl_output(line)

data/lib/krane/template_sets.rb

@@ -17,13 +17,14 @@ module Krane
         @render_erb = render_erb
       end
 
-      def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false)
+      def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false, partials_dir: nil)
         if @render_erb
           @renderer = Renderer.new(
             template_dir: @template_dir,
             logger: @logger,
             current_sha: current_sha,
             bindings: bindings,
+            partials_dir: partials_dir,
           )
         end
         with_delayed_exceptions(@files, Krane::InvalidTemplateError) do |filename|
@@ -123,20 +124,21 @@ module Krane
       end
     end
 
-    def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false)
+    def with_resource_definitions_and_filename(current_sha: nil, bindings: nil, raw: false, partials_dir: nil)
       with_delayed_exceptions(@template_sets, Krane::InvalidTemplateError) do |template_set|
         template_set.with_resource_definitions_and_filename(
           current_sha: current_sha,
           bindings: bindings,
-          raw: raw
+          raw: raw,
+          partials_dir: partials_dir,
         ) do |r_def, filename|
           yield r_def, filename
         end
       end
     end
 
-    def with_resource_definitions(current_sha: nil, bindings: nil, raw: false)
-      with_resource_definitions_and_filename(current_sha: current_sha, bindings: bindings, raw: raw) do |r_def, _|
+    def with_resource_definitions(current_sha: nil, bindings: nil, raw: false, partials_dir: nil)
+      with_resource_definitions_and_filename(current_sha: current_sha, bindings: bindings, raw: raw, partials_dir: partials_dir) do |r_def, _|
         yield r_def
       end
     end

data/lib/krane/version.rb

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

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: krane
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.7.1
 platform: ruby
 authors:
 - Katrina Verey
 - Daniel Turner
 - Kir Shatrov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -512,7 +511,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -527,8 +525,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: A command line tool that helps you ship changes to a Kubernetes namespace
   and understand the result