krane 2.4.8 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a785ceec99d9fef8328e541744ece449fde68685d953f410ad6ce4413c51e33b
-  data.tar.gz: 8a96a80cbed3f02d7bd5d241b12572f90de6432904535839843cac328894a9fa
+  metadata.gz: aeb4645e62609672df9a1a4fbe8323e801cdc904d45ae79aaa047d1f1cb8f1e7
+  data.tar.gz: de5c4a20c870041a532d22208c23d002f14c5ff0b6dae8ba8db1b9cc2d088c36
 SHA512:
-  metadata.gz: ba81377d1e1bb58ae30b6a19254d3403c4d1e18cd7bc748e7b6fa43dba54366a81f539e721febed5bb7c4e97dffb48c56c6ab5af04c193557d794cd5941cd638
-  data.tar.gz: 919a14fff6f1116eb587b1e5521255fc2a498de3139d7fd0402ce89a492fb18d5bb2e6cc53d08a4006e92ea10ca0b46b935c3386c964374130920b3463151f5f
+  metadata.gz: a8e4b1a9d17a537c533c8ecab1a7146c093ef6b0ddaedcbab76b7451d9ff18541ea73788614ba74739d1804a08146bb98e26d3f984b902dc6d609bcc8ca95a5a
+  data.tar.gz: 45aff6ae937b76ffb4cbb1f7fe3ffd4eceb73ae48442f8260c2a97689191cbfc991ba7767736aa2b048db51d5f1f169f8062d3e0d1c0c60acd8ee550c66e0690

data/.github/workflows/ci.yml

@@ -6,59 +6,46 @@ jobs:
   ruby-tests:
     runs-on: ubuntu-latest
 
-    name: "Tests - Ruby ${{ matrix.ruby }} with k8s ${{ matrix.kubernetes_version }}"
+    name: "Tests - Ruby ${{ matrix.ruby }} with Kubernetes ${{ matrix.kubernetes_version }}"
     strategy:
       fail-fast: false
       matrix:
         ruby:
-        # 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
+          - "3.1.2"
+          - "3.0.4"
+          - "2.7.6"
+        kubernetes_version:
+          - "1.24.6"
+          - "1.23.12"
+          - "1.22.15"
         include:
-        # Match kind images with chosen version https://github.com/kubernetes-sigs/kind/releases
-        - 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.2'
-          kind_version: 'v0.11.1'
-          kubernetes_version: '1.22.0'
-          kind_image: 'kindest/node:v1.22.0@sha256:b8bda84bb3a190e6e028b1760d277454a72267a5454b57db34437c34a588d047'
-        - ruby: '3.0.1'
-          kind_version: 'v0.11.1'
-          kubernetes_version: '1.21.1'
-          kind_image: 'kindest/node:v1.21.1@sha256:69860bda5563ac81e3c0057d654b5253219618a22ec3a346306239bba8cfa1a6'
-        - ruby: '3.0'
-          kind_version: 'v0.11.1'
-          kubernetes_version: '1.20.7'
-          kind_image: 'kindest/node:v1.20.7@sha256:cbeaf907fc78ac97ce7b625e4bf0de16e3ea725daf6b04f930bd14c67c671ff9'
-        - ruby: '2.7'
-          kind_version: 'v0.11.1'
-          kubernetes_version: '1.19.11'
-          kind_image: 'kindest/node:v1.19.11@sha256:07db187ae84b4b7de440a73886f008cf903fcf5764ba8106a9fd5243d6f32729'
+          - 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.22.15"
+            kind_image: "kindest/node:v1.22.15@sha256:bfd5eaae36849bfb3c1e3b9442f3da17d730718248939d9d547e86bbac5da586"
 
     steps:
       - uses: actions/checkout@v2
 
-      - name: Set up Ruby ${{ matrix.ruby }}
+      - name: Setup Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - name: Setup kubectl
+      - name: Setup kubectl ${{ matrix.kubernetes_version }}
         run: |
           mkdir -p "${GITHUB_WORKSPACE}/bin"
           curl -o "${GITHUB_WORKSPACE}/bin/kubectl" -LO "https://dl.k8s.io/release/v${{ matrix.kubernetes_version }}/bin/linux/amd64/kubectl"
           chmod +x "${GITHUB_WORKSPACE}/bin/kubectl"
           echo "PATH=$GITHUB_WORKSPACE/bin:${PATH}" >> $GITHUB_ENV
 
-      - uses: engineerd/setup-kind@v0.5.0
+      - name: Setup Kind v0.16.0
+        uses: engineerd/setup-kind@v0.5.0
         with:
-          version: "${{ matrix.kind_version }}"
+          version: v0.16.0
           image: "${{ matrix.kind_image }}"
 
       - name: Run tests

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## next
 
+
+## 3.0.0
+
+*Enhancements*
+
+- CI test matrix now test all Krane supported Ruby and Kubernetes versions.
+   Ruby: 3.1.2 , 3.0.4 , 2.7.6, Kubernetes: - 1.24.6, 1.23.12, 1.22.15.
+
+*Breaking Changes*
+- Remove unsupported Kubernetes and Ruby versions from Krane and CI [#905](https://github.com/Shopify/krane/pull/905).
+See supported Kubernetes and Ruby versions in  [Compatibility](./CONTRIBUTING.md#compatibility).
+If you are using Kubernetes <v1.22 keep using Krane v2.4.9.
+
+## 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

data/CONTRIBUTING.md

@@ -29,9 +29,7 @@ behavior to [krane@shopify.com](mailto:krane@shopify.com).
 ## Maintainers
 
 This project is currently under the stewardship of the Production Platform group at Shopify.
-The two primary maintainers are @knverey and @dturn. Approval from at least one primary maintainer is
-required for all significant feature proposals and code architecture changes. In general,
-two people must approve all non-trivial PRs.
+In general, two people must approve all non-trivial PRs.
 
 ## What should I know before I get started?
 
@@ -113,7 +111,7 @@ This gem uses subclasses of `KubernetesResource` to implement custom success/fai
 
 If you work for Shopify, just run `dev up`, but otherwise:
 
-1. [Install kubectl version 1.10.0 or higher](https://kubernetes.io/docs/user-guide/prereqs/) and make sure it is in your path
+1. [Install kubectl version 1.22.0 or higher](https://kubernetes.io/docs/user-guide/prereqs/) and make sure it is in your path
 2. [Install minikube](https://kubernetes.io/docs/getting-started-guides/minikube/#installation) (required to run the test suite)
 3. [Install any required minikube drivers](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md) (on OS X, you may need the [hyperkit driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver)
 4. Check out the repo

data/README.md

@@ -74,23 +74,28 @@ If you need the ability to render dynamic values in templates before deploying,
 ## Prerequisites
 
 * Ruby 2.7+
-* Your cluster must be running Kubernetes v1.19.0 or higher<sup>1</sup>
+* Your cluster must be running Kubernetes v1.22.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.
+## Compatibility
+
+<sup>1</sup> We run integration tests against these Kubernetes versions. You can find our official compatibility chart below.
+
+Krane provides support for official upstream supported versions [Kubernetes](https://endoflife.date/kubernetes), [Ruby](https://endoflife.date/ruby) that are part of the compatibility matrix; Nevertheless, older releases are still likely to work.
 
 | 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.19        | No                |                  2.4.9                   |
+|        1.20        | No                |                  2.4.9                   |
+|        1.21        | No                |                  2.4.9                   |
 |        1.22        | Yes               |                    --                    |
 |        1.23        | Yes               |                    --                    |
+|        1.24        | Yes               |                    --                    |
+|        1.25        | No                |                    --                    |
 
 ## Installation
 
-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
+1. [Install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl-binary-via-curl) (requires v1.22.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`
 
@@ -497,7 +502,7 @@ resource to restart.
 
 ## Prerequisites
 
-* You've already deployed a [`PodTemplate`](https://v1-15.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#podtemplate-v1-core) object with field `template` containing a `Pod` specification that does not include the `apiVersion` or `kind` parameters. An example is provided in this repo in `test/fixtures/hello-cloud/template-runner.yml`.
+* You've already deployed a [`PodTemplate`](https://v1-22.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podtemplate-v1-core) object with field `template` containing a `Pod` specification that does not include the `apiVersion` or `kind` parameters. An example is provided in this repo in `test/fixtures/hello-cloud/template-runner.yml`.
 * The `Pod` specification in that template has a container named `task-runner`.
 
 Based on this specification `krane run` will create a new pod with the entrypoint of the `task-runner ` container overridden with the supplied arguments.

data/bin/ci

@@ -16,5 +16,5 @@ docker run --rm \
     -e VERBOSE=1 \
     -e PARALLELISM=$PARALLELISM \
     -w /usr/src/app \
-    ruby:"${RUBY_VERSION:-2.6.6}" \
+    ruby:"${RUBY_VERSION:-2.7.6}" \
     bin/test

data/bin/setup

@@ -9,8 +9,8 @@ if [ ! -x "$(which minikube)" ]; then
 fi
 
 if [ ! -x "$(which kubectl)" ]; then
-  echo -e "\n\033[0;33mPlease install kubectl version 1.15.0 or higher:\nhttps://kubernetes.io/docs/user-guide/prereqs/\033[0m"
+  echo -e "\n\033[0;33mPlease install kubectl version 1.22.0 or higher:\nhttps://kubernetes.io/docs/user-guide/prereqs/\033[0m"
 else
   KUBECTL_VERSION=$(kubectl version --short --client | grep -oe "v[[:digit:]\.]\+")
-  echo -e "\n\033[0;32mKubectl version $KUBECTL_VERSION is already installed. This gem requires version v1.15.0 or greater.\033[0m"
+  echo -e "\n\033[0;32mKubectl version $KUBECTL_VERSION is already installed. This gem requires version v1.22.0 or greater.\033[0m"
 fi

data/dev.yml

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

data/krane.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = "https://rubygems.org"
 
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 2.7.6'
   spec.add_dependency("activesupport", ">= 5.0")
   spec.add_dependency("kubeclient", "~> 4.9")
   spec.add_dependency("googleauth", "~> 1.2")

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/cluster_resource_discovery.rb

@@ -37,19 +37,6 @@ module Krane
       end.compact.uniq { |r| "#{r['apigroup']}/#{r['kind']}" }
     end
 
-    def fetch_mutating_webhook_configurations
-      command = %w(get mutatingwebhookconfigurations)
-      raw_json, err, st = kubectl.run(*command, output: "json", attempts: 5, use_namespace: false)
-      if st.success?
-        JSON.parse(raw_json)["items"].map do |definition|
-          Krane::MutatingWebhookConfiguration.new(namespace: namespace, context: context, logger: logger,
-            definition: definition, statsd_tags: @namespace_tags)
-        end
-      else
-        raise FatalKubeAPIError, "Error retrieving mutatingwebhookconfigurations: #{err}"
-      end
-    end
-
     private
 
     # During discovery, the api paths may not actually be at the root, so we must programatically find it.

data/lib/krane/common.rb

@@ -20,5 +20,5 @@ require 'krane/task_config'
 require 'krane/task_config_validator'
 
 module Krane
-  MIN_KUBE_VERSION = '1.15.0'
+  MIN_KUBE_VERSION = '1.22.0'
 end

data/lib/krane/deploy_task.rb

@@ -30,7 +30,6 @@ require 'krane/kubernetes_resource'
   custom_resource_definition
   horizontal_pod_autoscaler
   secret
-  mutating_webhook_configuration
 ).each do |subresource|
   require "krane/kubernetes_resource/#{subresource}"
 end
@@ -285,26 +284,18 @@ module Krane
     end
     measure_method(:validate_configuration)
 
-    def partition_dry_run_resources(resources)
-      individuals = []
-      mutating_webhook_configurations = cluster_resource_discoverer.fetch_mutating_webhook_configurations
-      mutating_webhook_configurations.each do |mutating_webhook_configuration|
-        mutating_webhook_configuration.webhooks.each do |webhook|
-          individuals = (individuals + resources.select { |resource| webhook.matches_resource?(resource) }).uniq
-          resources -= individuals
-        end
-      end
-      [resources, individuals]
-    end
-
     def validate_resources(resources)
       validate_globals(resources)
-      batchable_resources, individuals = partition_dry_run_resources(resources.dup)
-      batch_dry_run_success = kubectl.server_dry_run_enabled? && validate_dry_run(batchable_resources)
-      individuals += batchable_resources unless batch_dry_run_success
+      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|
-        r.validate_definition(kubectl: kubectl, selector: @selector, dry_run: individuals.include?(r))
+        # No need to pass in kubectl (and do per-resource dry run apply) if batch dry run succeeded
+        if batch_dry_run_success
+          r.validate_definition(kubectl: nil, selector: @selector, dry_run: false)
+        else
+          r.validate_definition(kubectl: kubectl, selector: @selector, dry_run: true)
+        end
       end
       failed_resources = resources.select(&:validation_failed?)
       if failed_resources.present?

data/lib/krane/kubectl.rb

@@ -109,11 +109,7 @@ module Krane
     end
 
     def dry_run_flag
-      if client_version >= Gem::Version.new("1.18")
-        "--dry-run=server"
-      else
-        "--server-dry-run"
-      end
+      "--dry-run=server"
     end
 
     private

data/lib/krane/kubernetes_resource.rb

@@ -226,11 +226,6 @@ module Krane
       version ? grouping : "core"
     end
 
-    def version
-      prefix, version = @definition.dig("apiVersion").split("/")
-      version || prefix
-    end
-
     def kubectl_resource_type
       type
     end
@@ -569,11 +564,7 @@ module Krane
 
     # Server side dry run is only supported on apply
     def validate_with_server_side_dry_run(kubectl)
-      command = if kubectl.client_version >= Gem::Version.new('1.18')
-        ["apply", "-f", file_path, "--dry-run=server", "--output=name"]
-      else
-        ["apply", "-f", file_path, "--server-dry-run", "--output=name"]
-      end
+      command = ["apply", "-f", file_path, "--dry-run=server", "--output=name"]
 
       kubectl.run(*command, log_failure: false, output_is_sensitive: sensitive_template_content?,
         retry_whitelist: [:client_timeout, :empty, :context_deadline], attempts: 3)
@@ -584,11 +575,7 @@ module Krane
     # If the resource template uses generateName, validating with apply will fail
     def validate_with_local_dry_run(kubectl)
       verb = deploy_method == :apply ? "apply" : "create"
-      command = if kubectl.client_version >= Gem::Version.new('1.18')
-        [verb, "-f", file_path, "--dry-run=client", "--output=name"]
-      else
-        [verb, "-f", file_path, "--dry-run", "--output=name"]
-      end
+      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?)

data/lib/krane/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: krane
 version: !ruby/object:Gem::Version
-  version: 2.4.8
+  version: 3.0.0
 platform: ruby
 authors:
 - Katrina Verey
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -413,9 +413,9 @@ extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
 - ".github/ISSUE_TEMPLATE.md"
-- ".github/probots.yml"
 - ".github/pull_request_template.md"
 - ".github/workflows/ci.yml"
+- ".github/workflows/cla.yml"
 - ".gitignore"
 - ".rubocop-http---shopify-github-io-ruby-style-guide-rubocop-yml"
 - ".rubocop.yml"
@@ -472,7 +472,6 @@ files:
 - lib/krane/kubernetes_resource/horizontal_pod_autoscaler.rb
 - lib/krane/kubernetes_resource/ingress.rb
 - lib/krane/kubernetes_resource/job.rb
-- lib/krane/kubernetes_resource/mutating_webhook_configuration.rb
 - lib/krane/kubernetes_resource/network_policy.rb
 - lib/krane/kubernetes_resource/persistent_volume_claim.rb
 - lib/krane/kubernetes_resource/pod.rb
@@ -519,7 +518,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/probots.yml

@@ -1,2 +0,0 @@
-enabled:
-  - cla

data/lib/krane/kubernetes_resource/mutating_webhook_configuration.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-module Krane
-  class MutatingWebhookConfiguration < KubernetesResource
-    GLOBAL = true
-
-    class Webhook
-      EQUIVALENT = 'Equivalent'
-      EXACT = 'Exact'
-
-      class Rule
-        def initialize(definition)
-          @definition = definition
-        end
-
-        def matches_resource?(resource, accept_equivalent:)
-          groups.each do |group|
-            versions.each do |version|
-              resources.each do |kind|
-                return true if (resource.group == group || group == '*' || accept_equivalent) &&
-                  (resource.version == version || version == '*' || accept_equivalent) &&
-                  (resource.type.downcase == kind.downcase.singularize || kind == "*")
-              end
-            end
-          end
-          false
-        end
-
-        def groups
-          @definition.dig('apiGroups')
-        end
-
-        def versions
-          @definition.dig('apiVersions')
-        end
-
-        def resources
-          @definition.dig('resources')
-        end
-      end
-
-      def initialize(definition)
-        @definition = definition
-      end
-
-      def side_effects
-        @definition.dig('sideEffects')
-      end
-
-      def has_side_effects?
-        # Note: After K8s 1.22, this should ALWAYS be false.
-        !%w(None NoneOnDryRun).include?(side_effects)
-      end
-
-      def match_policy
-        @definition.dig('matchPolicy')
-      end
-
-      def matches_resource?(resource, skip_rule_if_side_effect_none: true)
-        return false if skip_rule_if_side_effect_none && !has_side_effects?
-        rules.any? do |rule|
-          rule.matches_resource?(resource, accept_equivalent: match_policy == EQUIVALENT)
-        end
-      end
-
-      def rules
-        @definition.fetch('rules', []).map { |rule| Rule.new(rule) }
-      end
-    end
-
-    def initialize(namespace:, context:, definition:, logger:, statsd_tags:)
-      @webhooks = (definition.dig('webhooks') || []).map { |hook| Webhook.new(hook) }
-      super(namespace: namespace, context: context, definition: definition,
-        logger: logger, statsd_tags: statsd_tags)
-    end
-
-    TIMEOUT = 30.seconds
-
-    def deploy_succeeded?
-      exists?
-    end
-
-    def webhooks
-      @definition.fetch('webhooks', []).map { |webhook| Webhook.new(webhook) }
-    end
-  end
-end