kubernetes-deploy 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e7827354d151cb81a0955882abede556706c6e82faabad54e4b44d36746927f
-  data.tar.gz: '083dd77e75f92608d6c04c59a8edab5dbc35da3725e3cddc7fee99706c3655d7'
+  metadata.gz: 2f9a199d384a4137903191ff608290e6ff0c22423f8c783e866160fc546f7d00
+  data.tar.gz: 8936ac0d23a1cb1534df26b3e1a5e78ca75006ed929bd00fb6bc70877b3342c4
 SHA512:
-  metadata.gz: 8ee6de674126f680b470b35f33c08056095284fd29ee5a267781172b170e4de39f77d442a4e530d44ecee46ddd35a5323821f2dafbe20618aa7d0e30135eb801
-  data.tar.gz: 1746664b8c13c7c8bc64f2c6903bb62761b13f8d45e6177f82338776c2d67f3979d9e80b8a38b15290b7818d473b2967d18e1a8784cf72c30880c64f40ff5f6d
+  metadata.gz: 37add457c1cb9e1deb7691a73318b413407dbe58c7326eff5769cd88afebc56cee6b53fa8c399cd0a44c1b89078d5cb32fa50492c18e5963fa9a776967979ffd
+  data.tar.gz: f16bf5443c6eb37a187e0bfbb82d21222d83dbaa4387a7958041d46dfef39086fbcc398c09acc1ab998a17e9031ddd0d7866e48dee318ef0b8cf3fc01e874f91

data/.rubocop.yml

@@ -14,4 +14,4 @@ Sorbet/ConstantsFromStrings:
 
 Layout/Tab:
   Exclude:
-    - test/integration/kubernetes_deploy_test.rb
+    - test/integration/krane_deploy_test.rb

data/CHANGELOG.md

@@ -3,6 +3,21 @@
 *Important!*
 - The next release will be 1.0.0, which means that master will contain breaking changes.
 
+## 0.31
+
+*Enhancements*
+- (alpha) Add a new krane global-deploy task for deploying global resources. Note that global pruning is turned on by default ([#602](https://github.com/Shopify/kubernetes-deploy/pull/602) and [#612](https://github.com/Shopify/kubernetes-deploy/pull/612))
+- Add support for deploying resources that use `generateName` ([#608](https://github.com/Shopify/kubernetes-deploy/pull/608))
+- ENV["REVISION"] is not transparently passed into krane. Instead, you must now use the `--current-sha` flag to set the `current_sha` ERB binding in your templates. Note that kubernetes-deploy, _but not krane_, can still use ENV["REVISION"] as a fallback if `--current-sha` is not provided. ([#613](https://github.com/Shopify/kubernetes-deploy/pull/613))
+
+*Bug Fixes*
+- `krane deploy` can accept multiple filenames with `-f` flag ([#606](https://github.com/Shopify/kubernetes-deploy/pull/606))
+- Ensure DaemonSet status has converged with pod statuses before reporting rollout success ([#617](https://github.com/Shopify/kubernetes-deploy/pull/617))
+
+*Other*
+- Update references from using `kubernetes-deploy` to `krane` in preparation for 1.0 release ([#585](https://github.com/Shopify/kubernetes-deploy/pull/585))
+- Refactor StatsD usage so we can depend on the latest version again. ([#594](https://github.com/Shopify/kubernetes-deploy/pull/594))
+
 ## 0.30.0
 
 *Enhancements*

data/CONTRIBUTING.md

@@ -141,9 +141,9 @@ Using another local cluster:
 2. Put the name of the context you want to use in a file named `.local-context` in the root of this project. For example: `echo "dind" > .local-context`.
 3. Run `bundle exec rake test` (or `dev test` if you work for Shopify).
 
-To make StatsD log what it would have emitted, run a test with `STATSD_DEV=1`.
+To make StatsD log what it would have emitted, run a test with `STATSD_ENV=development`.
 
-To see the full-color output of a specific integration test, you can use `PRINT_LOGS=1`. For example: `PRINT_LOGS=1 bundle exec ruby -I test test/integration/kubernetes_deploy_test.rb -n/test_name/`.
+To see the full-color output of a specific integration test, you can use `PRINT_LOGS=1`. For example: `PRINT_LOGS=1 bundle exec ruby -I test test/integration/krane_deploy_test.rb -n/test_name/`.
 
 
 ![test-output](screenshots/test-output.png)

data/README.md

@@ -268,7 +268,7 @@ To run a task in your cluster at the beginning of every deploy, simply include a
 * The pod's `spec.restartPolicy` must be set to `Never` so that it will be run exactly once. We'll fail the deploy if that run exits with a non-zero status.
 * The pod's `spec.activeDeadlineSeconds` should be set to a reasonable value for the performed task (not required, but highly recommended)
 
-A simple example can be found in the test fixtures: test/fixtures/hello-cloud/unmanaged-pod.yml.erb.
+A simple example can be found in the test fixtures: [test/fixtures/hello-cloud/unmanaged-pod-1.yml.erb](test/fixtures/hello-cloud/unmanaged-pod-1.yml.erb).
 
 The logs of all pods run in this way will be printed inline. If there is only one pod, the logs will be streamed in real-time. If there are multiple, they will be fetched when the pod terminates.
 

data/dev.yml

@@ -19,7 +19,7 @@ commands:
   test:
     run: bin/test
   tophat:
-    run: PRINT_LOGS=1 bundle exec ruby -I test test/integration/kubernetes_deploy_test.rb -n/${1}/
+    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.
     syntax:
       optional:

data/dev/flamegraph-from-tests

@@ -22,7 +22,7 @@ if [[ -f $PROFILE_FILENAME ]]; then
 fi
 
 echo "Running test(s) with profiling"
-PROFILE=1 bundle exec ruby -I test test/integration/kubernetes_deploy_test.rb -n /$1/ > /dev/null
+PROFILE=1 bundle exec ruby -I test test/integration/krane_deploy_test.rb -n /$1/ > /dev/null
 
 echo "Processing profile"
 cat $PROFILE_FILENAME | perl -w $FLAMEGRAPH_PL --countname=ms --width=1500 --title=$1 > $SVG_FILENAME

data/exe/kubernetes-deploy

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 
 require 'kubernetes-deploy/deploy_task'
-require 'kubernetes-deploy/options_helper'
-require 'kubernetes-deploy/bindings_parser'
-require 'kubernetes-deploy/label_selector'
+require 'krane/options_helper'
+require 'krane/bindings_parser'
+require 'krane/label_selector'
 
 require 'optparse'
 
@@ -17,9 +17,10 @@ bindings = {}
 verbose_log_prefix = false
 max_watch_seconds = nil
 selector = nil
+current_sha = ENV["REVISION"]
 
 ARGV.options do |opts|
-  parser = KubernetesDeploy::BindingsParser.new
+  parser = Krane::BindingsParser.new
   opts.on("--bindings=BINDINGS", "Expose additional variables to ERB templates " \
     "(format: k1=v1,k2=v2, JSON string or file (JSON or YAML) path prefixed by '@')") { |b| parser.add(b) }
 
@@ -41,7 +42,7 @@ ARGV.options do |opts|
   end
   opts.on("--selector=SELECTOR", "Ensure that all resources in your template dir match the given selector, " \
     "and restrict pruning to deployed resources it selects.  (format: k1=v1,k2=v2)") do |s|
-    selector = KubernetesDeploy::LabelSelector.parse(s)
+    selector = Krane::LabelSelector.parse(s)
   end
 
   opts.on_tail("-h", "--help", "Print this help") do
@@ -49,16 +50,17 @@ ARGV.options do |opts|
     exit
   end
   opts.on_tail("-v", "--version", "Show version") do
-    puts "v#{KubernetesDeploy::VERSION}"
+    puts "v#{Krane::VERSION}"
     exit
   end
+  opts.on("--current-sha=CURRENT_SHA", "Expose SHA `current_sha` in ERB bindings") { |r| current_sha = r }
   opts.parse!
   bindings = parser.parse
 end
 
 namespace = ARGV[0]
 context = ARGV[1]
-logger = KubernetesDeploy::FormattedLogger.build(namespace, context, verbose_prefix: verbose_log_prefix)
+logger = Krane::FormattedLogger.build(namespace, context, verbose_prefix: verbose_log_prefix)
 
 # Deprecation path: this can be removed when --template-dir is fully replaced by -f
 if template_dir && !template_paths.empty?
@@ -68,11 +70,11 @@ end
 template_paths = [template_dir] if template_paths.empty? && template_dir
 
 begin
-  KubernetesDeploy::OptionsHelper.with_processed_template_paths(template_paths) do |paths|
+  Krane::OptionsHelper.with_processed_template_paths(template_paths) do |paths|
     runner = KubernetesDeploy::DeployTask.new(
       namespace: namespace,
       context: context,
-      current_sha: ENV["REVISION"],
+      current_sha: current_sha,
       template_paths: paths,
       bindings: bindings,
       logger: logger,

data/exe/kubernetes-render

@@ -2,32 +2,34 @@
 # frozen_string_literal: true
 
 require 'kubernetes-deploy/render_task'
-require 'kubernetes-deploy/options_helper'
-require 'kubernetes-deploy/bindings_parser'
+require 'krane/options_helper'
+require 'krane/bindings_parser'
 
 require 'optparse'
 
 template_dir = []
 bindings = {}
+current_sha = ENV["REVISION"]
 
 ARGV.options do |opts|
-  parser = KubernetesDeploy::BindingsParser.new
+  parser = Krane::BindingsParser.new
   opts.on("--bindings=BINDINGS", "Expose additional variables to ERB templates " \
     "(format: k1=v1,k2=v2, JSON string or file (JSON or YAML) path prefixed by '@')") { |b| parser.add(b) }
   opts.on("--template-dir=DIR", "Set the template dir (default: config/deploy/$ENVIRONMENT).") do |d|
     template_dir = [d]
   end
+  opts.on("--current-sha=CURRENT_SHA", "Expose SHA `current_sha` in ERB bindings") { |r| current_sha = r }
   opts.parse!
   bindings = parser.parse
 end
 
 templates = ARGV
-logger = KubernetesDeploy::FormattedLogger.build(verbose_prefix: false)
+logger = Krane::FormattedLogger.build(verbose_prefix: false)
 
 begin
-  KubernetesDeploy::OptionsHelper.with_processed_template_paths(template_dir) do |dir|
+  Krane::OptionsHelper.with_processed_template_paths(template_dir) do |dir|
     runner = KubernetesDeploy::RenderTask.new(
-      current_sha: ENV["REVISION"],
+      current_sha: current_sha,
       template_dir: dir.first,
       bindings: bindings,
     )
@@ -35,7 +37,7 @@ begin
     success = runner.run(STDOUT, templates)
     exit(1) unless success
   end
-rescue KubernetesDeploy::OptionsHelper::OptionsError => e
+rescue Krane::OptionsHelper::OptionsError => e
   logger.error(e.message)
   exit(1)
 end

data/exe/kubernetes-restart

@@ -4,8 +4,8 @@
 require 'optparse'
 
 require 'kubernetes-deploy/restart_task'
-require 'kubernetes-deploy/options_helper'
-require 'kubernetes-deploy/label_selector'
+require 'krane/options_helper'
+require 'krane/label_selector'
 
 raw_deployments = nil
 max_watch_seconds = nil
@@ -14,7 +14,7 @@ ARGV.options do |opts|
   opts.on("--deployments=LIST") { |v| raw_deployments = v.split(",") }
   opts.on("--max-watch-seconds=seconds") { |t| max_watch_seconds = t.to_i }
   opts.on("--selector=SELECTOR", "Restarts deployments matching selector (format: k1=v1,k2=v2)") do |s|
-    selector = KubernetesDeploy::LabelSelector.parse(s)
+    selector = Krane::LabelSelector.parse(s)
   end
   opts.parse!
 end

data/exe/kubernetes-run

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'kubernetes-deploy/runner_task'
-require 'kubernetes-deploy/options_helper'
+require 'krane/options_helper'
 require 'optparse'
 
 template = "task-runner-template"

data/kubernetes-deploy.gemspec

@@ -2,11 +2,11 @@
 # frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'kubernetes-deploy/version'
+require 'krane/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "kubernetes-deploy"
-  spec.version       = KubernetesDeploy::VERSION
+  spec.version       = Krane::VERSION
   spec.authors       = ["Katrina Verey", "Kir Shatrov"]
   spec.email         = ["ops-accounts+shipit@shopify.com"]
 
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency("googleauth", "~> 0.8.0")
   spec.add_dependency("ejson", "~> 1.0")
   spec.add_dependency("colorize", "~> 0.8")
-  spec.add_dependency("statsd-instrument", '~> 2.3.2')
+  spec.add_dependency("statsd-instrument", ['>= 2.8', "< 3.1"])
   spec.add_dependency("oj", "~> 3.0")
   spec.add_dependency("concurrent-ruby", "~> 1.1")
   spec.add_dependency("jsonpath", "~> 0.9.6")

data/lib/krane.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
-require 'kubernetes-deploy/common'
 
-module Krane
-end
+require 'krane/deploy_task'
+require 'krane/render_task'
+require 'krane/restart_task'
+require 'krane/runner_task'
+require 'krane/global_deploy_task'

data/lib/{kubernetes-deploy → krane}/bindings_parser.rb

@@ -3,7 +3,7 @@ require 'json'
 require 'yaml'
 require 'csv'
 
-module KubernetesDeploy
+module Krane
   class BindingsParser
     def self.parse(string)
       new(string).parse

data/lib/krane/cli/deploy_command.rb

@@ -13,8 +13,9 @@ module Krane
         "bindings" => { type: :array, banner: "foo=bar abc=def",
                         desc: "Expose additional variables to ERB templates (format: k1=v1 k2=v2, JSON string or file "\
                           "(JSON or YAML) path prefixed by '@')" },
-        "filenames" => { type: :string, banner: '/tmp/my-resource.yml', aliases: :f, required: true,
-                         desc: "Path to file or directory that contains the configuration to apply" },
+        "filenames" => { type: :array, banner: 'config/deploy/production config/deploy/my-extra-resource.yml',
+                         aliases: :f, required: true,
+                         desc: "Directories and files that contains the configuration to apply" },
         "global-timeout" => { type: :string, banner: "duration", default: DEFAULT_DEPLOY_TIMEOUT,
                               desc: "Max duration to monitor workloads correctly deployed" },
         "protected-namespaces" => { type: :array, banner: "namespace1 namespace2 namespaceN",
@@ -30,20 +31,22 @@ module Krane
                                   default: true },
         "verify-result" => { type: :boolean, default: true,
                              desc: "Verify workloads correctly deployed" },
+        "current-sha" => { type: :string, banner: "SHA", desc: "Expose SHA `current_sha` in ERB bindings" },
+
       }
 
       def self.from_options(namespace, context, options)
         require 'krane/deploy_task'
-        require 'kubernetes-deploy/options_helper'
-        require 'kubernetes-deploy/bindings_parser'
-        require 'kubernetes-deploy/label_selector'
+        require 'krane/options_helper'
+        require 'krane/bindings_parser'
+        require 'krane/label_selector'
 
-        bindings_parser = KubernetesDeploy::BindingsParser.new
+        bindings_parser = ::Krane::BindingsParser.new
         options[:bindings]&.each { |binding_pair| bindings_parser.add(binding_pair) }
 
-        selector = KubernetesDeploy::LabelSelector.parse(options[:selector]) if options[:selector]
+        selector = ::Krane::LabelSelector.parse(options[:selector]) if options[:selector]
 
-        logger = KubernetesDeploy::FormattedLogger.build(namespace, context,
+        logger = ::Krane::FormattedLogger.build(namespace, context,
           verbose_prefix: options['verbose-log-prefix'])
 
         protected_namespaces = options['protected-namespaces']
@@ -51,16 +54,16 @@ module Krane
           protected_namespaces = []
         end
 
-        KubernetesDeploy::OptionsHelper.with_processed_template_paths([options[:filenames]],
+        ::Krane::OptionsHelper.with_processed_template_paths(options[:filenames],
           require_explicit_path: true) do |paths|
           deploy = ::Krane::DeployTask.new(
             namespace: namespace,
             context: context,
-            current_sha: ENV["REVISION"],
+            current_sha: options['current-sha'],
             template_paths: paths,
             bindings: bindings_parser.parse,
             logger: logger,
-            max_watch_seconds: KubernetesDeploy::DurationParser.new(options["global-timeout"]).parse!.to_i,
+            max_watch_seconds: ::Krane::DurationParser.new(options["global-timeout"]).parse!.to_i,
             selector: selector,
             protected_namespaces: protected_namespaces,
           )

data/lib/krane/cli/global_deploy_command.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Krane
+  module CLI
+    class GlobalDeployCommand
+      DEFAULT_DEPLOY_TIMEOUT = '300s'
+      OPTIONS = {
+        "filenames" => { type: :array, banner: 'config/deploy/production config/deploy/my-extra-resource.yml',
+                         aliases: :f, required: true,
+                         desc: "Directories and files that contains the configuration to apply" },
+        "global-timeout" => { type: :string, banner: "duration", default: DEFAULT_DEPLOY_TIMEOUT,
+                              desc: "Max duration to monitor workloads correctly deployed" },
+        "verify-result" => { type: :boolean, default: true,
+                             desc: "Verify workloads correctly deployed" },
+        "selector" => { type: :string, banner: "'label=value'", required: true,
+                        desc: "Select workloads owned by selector(s)" },
+        "prune" => { type: :boolean, desc: "Enable deletion of resources that match"\
+                     " the provided selector and do not appear in the provided templates",
+                     default: true },
+      }
+
+      def self.from_options(context, options)
+        require 'krane/global_deploy_task'
+        require 'krane/options_helper'
+        require 'krane/label_selector'
+        require 'krane/duration_parser'
+
+        selector = ::Krane::LabelSelector.parse(options[:selector])
+
+        ::Krane::OptionsHelper.with_processed_template_paths(options[:filenames],
+          require_explicit_path: true) do |paths|
+          deploy = ::Krane::GlobalDeployTask.new(
+            context: context,
+            filenames: paths,
+            global_timeout: ::Krane::DurationParser.new(options["global-timeout"]).parse!.to_i,
+            selector: selector,
+          )
+
+          deploy.run!(
+            verify_result: options["verify-result"],
+            prune: options[:prune],
+          )
+        end
+      end
+    end
+  end
+end

data/lib/krane/cli/krane.rb

@@ -7,6 +7,7 @@ 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'
 
 module Krane
   module CLI
@@ -58,6 +59,14 @@ module Krane
         end
       end
 
+      desc("global-deploy CONTEXT", "Ship non-namespaced resources to a cluster")
+      expand_options(GlobalDeployCommand::OPTIONS)
+      def global_deploy(context)
+        rescue_and_exit do
+          GlobalDeployCommand.from_options(context, options)
+        end
+      end
+
       def self.exit_on_failure?
         true
       end
@@ -66,11 +75,11 @@ module Krane
 
       def rescue_and_exit
         yield
-      rescue KubernetesDeploy::DeploymentTimeoutError
+      rescue ::Krane::DeploymentTimeoutError
         exit(TIMEOUT_EXIT_CODE)
-      rescue KubernetesDeploy::FatalDeploymentError
+      rescue ::Krane::FatalDeploymentError
         exit(FAILURE_EXIT_CODE)
-      rescue KubernetesDeploy::DurationParser::ParsingError => e
+      rescue ::Krane::DurationParser::ParsingError => e
         STDERR.puts(<<~ERROR_MESSAGE)
           Error parsing duration
           #{e.message}. Duration must be a full ISO8601 duration or time value (e.g. 300s, 10m, 1h)

data/lib/krane/cli/render_command.rb

@@ -4,21 +4,23 @@ module Krane
   module CLI
     class RenderCommand
       OPTIONS = {
-        bindings: { type: :array, desc: 'Bindings for erb' },
-        filenames: { type: :array, required: true, aliases: 'f', desc: 'Directories and files to render' },
+        bindings: { type: :array, banner: "foo=bar abc=def", desc: 'Bindings for erb' },
+        filenames: { type: :array, banner: 'config/deploy/production config/deploy/my-extra-resource.yml',
+                     required: true, aliases: 'f', desc: 'Directories and files to render' },
+        'current-sha': { type: :string, banner: "SHA", desc: "Expose SHA `current_sha` in ERB bindings" },
       }
 
       def self.from_options(options)
-        require 'kubernetes-deploy/render_task'
-        require 'kubernetes-deploy/bindings_parser'
-        require 'kubernetes-deploy/options_helper'
+        require 'krane/render_task'
+        require 'krane/bindings_parser'
+        require 'krane/options_helper'
 
-        bindings_parser = KubernetesDeploy::BindingsParser.new
+        bindings_parser = ::Krane::BindingsParser.new
         options[:bindings]&.each { |b| bindings_parser.add(b) }
 
-        KubernetesDeploy::OptionsHelper.with_processed_template_paths(options[:filenames]) do |paths|
-          runner = KubernetesDeploy::RenderTask.new(
-            current_sha: ENV["REVISION"],
+        ::Krane::OptionsHelper.with_processed_template_paths(options[:filenames]) do |paths|
+          runner = ::Krane::RenderTask.new(
+            current_sha: options['current-sha'],
             template_paths: paths,
             bindings: bindings_parser.parse,
           )