Merge branch 'Shopify:main' into master

Author: strowi

.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"

CHANGELOG.md

@@ -1,5 +1,31 @@
 ## next
 
+## 3.7.2
+
+- Explicitly convert `current_generation` and `observed_generation` values to integers using `.to_i` to ensure consistentency during comparison
+
+## 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.
+
+## 3.6.1
+
+*Features*
+
+- Enable the option to bypass endpoint validation for a service by using the annotation `krane.shopify.io/skip-endpoint-validation: true`.
+
 ## 3.6.0
 
 - Test against k8s 1.29, 1.30

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
 
@@ -176,6 +177,10 @@ before the deployment is considered successful.
   - _Accepted values_: `create`, `replace`, and `replace-force`
   - _Warning_: Resources whose deploy method is overridden are no longer subject to pruning on deploy.
   - This feature is _experimental_ and may be removed at any time.
+- `krane.shopify.io/skip-endpoint-validation`: Skip endpoint validation for the service.
+  - _Compatibility_: Service
+  - _Default_: `false`
+  - `true`: Endpoint validation is not performed during the deployment of the service.
 
 
 ### Running tasks at the beginning of a deploy

dev.yml

@@ -6,10 +6,18 @@ 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
+    run: bin/test unit_test && bin/test cli_test && bin/test serial_integration_test && bin/test integration_test
+  test-unit:
+    run: bin/test unit_test
+  test-cli:
+    run: bin/test cli_test
+  test-serial_integration:
+    run: bin/test serial_integration_test,
+  test-integration:
+    run: bin/test integration_test
   tophat:
     run: PRINT_LOGS=1 bundle exec ruby -I test test/integration/krane_deploy_test.rb -n/${1}/
     desc: Tophat a change by running a test scenario with logging output enabled.

krane.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   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"])
+  spec.add_dependency("statsd-instrument", ['>= 2.8', "< 3.9"])
   spec.add_dependency("multi_json")
   spec.add_dependency("concurrent-ruby", "~> 1.1")
   spec.add_dependency("jsonpath", "~> 1.0")

lib/krane/cli/render_command.rb

@@ -11,6 +11,8 @@ class RenderCommand
                      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 @@ def self.from_options(options)
             current_sha: options['current-sha'],
             filenames: paths,
             bindings: bindings_parser.parse,
+            partials_dir: options['partials-dir'],
           )
           renderer.run!(stream: STDOUT)
         end

lib/krane/kubernetes_resource.rb

@@ -204,13 +204,13 @@ def exists?
 
     def current_generation
       return -1 unless exists? # must be different default than observed_generation
-      @instance_data.dig("metadata", "generation")
+      @instance_data.dig("metadata", "generation")&.to_i
     end
 
     def observed_generation
       return -2 unless exists?
       # populating this is a best practice, but not all controllers actually do it
-      @instance_data.dig('status', 'observedGeneration')
+      @instance_data.dig('status', 'observedGeneration')&.to_i
     end
 
     def status

lib/krane/kubernetes_resource/service.rb

@@ -5,6 +5,7 @@ module Krane
   class Service < KubernetesResource
     TIMEOUT = 7.minutes
     SYNC_DEPENDENCIES = %w(Pod Deployment StatefulSet)
+    SKIP_ENDPOINT_VALIDATION_ANNOTATION = 'skip-endpoint-validation'
 
     def sync(cache)
       super
@@ -59,6 +60,9 @@ def exposes_zero_replica_workload?
     end
 
     def requires_endpoints?
+      # skip validation if the annotation is present
+      return false if skip_endpoint_validation
+
       # services of type External don't have endpoints
       return false if external_name_svc?
 
@@ -96,5 +100,9 @@ def requires_publishing?
     def published?
       @instance_data.dig('status', 'loadBalancer', 'ingress').present?
     end
+
+    def skip_endpoint_validation
+      krane_annotation_value(SKIP_ENDPOINT_VALIDATION_ANNOTATION) == 'true'
+    end
   end
 end

lib/krane/render_task.rb

@@ -14,11 +14,13 @@ class RenderTask
     # @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 @@ def render_templates(stream, template_sets)
       @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

lib/krane/renderer.rb

@@ -16,11 +16,14 @@ def initialize(msg, parents: [], content: nil, filename:)
     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