kubernetes-deploy 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f957b471692e6ab3020ab729e76b02544e63857e
-  data.tar.gz: 32051ea0acada35ba395fe7075faa3bb2ccb51c2
+  metadata.gz: 861c1898e40c08f1120bc55896920e0359f3f674
+  data.tar.gz: 6c34e454e654acfba418245f3b2a2896272885cb
 SHA512:
-  metadata.gz: 8b3418099ae88193d13948f178968ae432d08860b569c8831985aff46740da265b277b3c10cfd759a387e1163193849ecb10907e9a55368d9919f25395cd7041
-  data.tar.gz: 34a8799cb0c017d2fa49fe5b0fea72783955b624eeee66bc6d1a537799ca3d17603821e49c631faa5bcbcb60971a21c87caef89197b9c812075c842193ab186e
+  metadata.gz: 4fc044006b4330a42b2d7b60e4b45c67b5be86ffd1c2e4017be9042f21d38a9d695058413ce78a9112406b0c8abf8e3c15bcf04f331f7ccf196cdcff6e62b387
+  data.tar.gz: 61e7d6cd0d6c706fb1db1a601708f781005db36b3e932e8c22a18463580c4b8c551bfdac2db2df0b0ebef1b75258e2e1ae81044595cf7345c4fced52c4f97b6c

data/README.md

@@ -257,6 +257,8 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 To see the full-color output of a specific integration test, you can use `PRINT_LOGS=1 bundle exec ruby -I test test/integration/kubernetes_deploy_test.rb -n/test_name/`.
 
+To make StatsD log what it would have emitted, run a test with `STATSD_DEV=1`.
+
 
 
 ![test-output](screenshots/test-output.png)
@@ -265,11 +267,12 @@ To see the full-color output of a specific integration test, you can use `PRINT_
 
 ## Releasing a new version (Shopify employees)
 
-1. Update the version number in `version.rb` and commit that change alone to master.
-2. Tag the version with `git tag vx.y.z && git push --tags`
-3. Use the [Shipit Stack](https://shipit.shopify.io/shopify/kubernetes-deploy/rubygems) to build the `.gem` file and upload to [rubygems.org](https://rubygems.org/gems/kubernetes-deploy).
+1. Update the version number in `version.rb` and commit that change with message "Version x.y.z". Don't push yet or you'll confuse Shipit.
+2. Tag the version with `git tag vx.y.z -a -m "Version x.y.z"`
+3. Push both your bump commit and its tag simultaneously with `git push origin master --follow-tags` (note that you can set `git config --global push.followTags true` to turn this flag on by default)
+4. Use the [Shipit Stack](https://shipit.shopify.io/shopify/kubernetes-deploy/rubygems) to build the `.gem` file and upload to [rubygems.org](https://rubygems.org/gems/kubernetes-deploy).
 
-If Shipit fails with `You need to create the v0.7.9 tag first.` even though you're sure you've already pushed that tag, go to `Settings` > `Resynchronize this stack` > `Clear git cache`.
+If you push your commit and the tag separately, Shipit usually fails with `You need to create the v0.7.9 tag first.`. To make it find your tag, go to `Settings` > `Resynchronize this stack` > `Clear git cache`.
 
 
 

data/lib/kubernetes-deploy/kubernetes_resource/pod.rb

@@ -19,6 +19,7 @@ module KubernetesDeploy
       if pod_data.blank?
         raw_json, _err, st = kubectl.run("get", type, @name, "-a", "--output=json")
         pod_data = JSON.parse(raw_json) if st.success?
+        raise_predates_deploy_error if pod_data.present? && unmanaged? && !@deploy_started
       end
 
       if pod_data.present?
@@ -147,6 +148,19 @@ module KubernetesDeploy
       @already_displayed = true
     end
 
+    def raise_predates_deploy_error
+      example_color = :green
+      msg = <<-STRING.strip_heredoc
+        Unmanaged pods like #{id} must have unique names on every deploy in order to work as intended.
+        The recommended way to achieve this is to include "<%= deployment_id %>" in the pod's name, like this:
+          #{ColorizedString.new('kind: Pod').colorize(example_color)}
+          #{ColorizedString.new('metadata:').colorize(example_color)}
+            #{ColorizedString.new("name: #{@name}-<%= deployment_id %>").colorize(example_color)}
+      STRING
+      @logger.summary.add_paragraph(msg)
+      raise FatalDeploymentError, "#{id} existed before the deploy started"
+    end
+
     class Container
       STATUS_SCAFFOLD = {
         "state" => {

data/lib/kubernetes-deploy/runner.rb

@@ -187,16 +187,11 @@ module KubernetesDeploy
 
     # Inspect the file referenced in the kubectl stderr
     # to make it easier for developer to understand what's going on
-    def find_bad_file_from_kubectl_output(stderr)
-      # Output example:
-      # Error from server (BadRequest): error when creating "/path/to/configmap-gqq5oh.yml20170411-33615-t0t3m":
-      match = stderr.match(%r{BadRequest.*"(?<path>\/\S+\.ya?ml\S*)"})
-      return unless match
-
-      path = match[:path]
-      if path.present? && File.file?(path)
-        File.read(path)
-      end
+    def find_bad_files_from_kubectl_output(stderr)
+      # stderr often contains one or more lines like the following, from which we can extract the file path(s):
+      # Error from server (TypeOfError): error when creating "/path/to/service-gqq5oh.yml": Service "web" is invalid:
+      matches = stderr.scan(%r{"(/\S+\.ya?ml\S*)"})
+      matches.flatten if matches
     end
 
     def deploy_has_priority_resources?(resources)
@@ -239,17 +234,8 @@ module KubernetesDeploy
       command = ["create", "-f", file_path, "--dry-run", "--output=name"]
       _, err, st = kubectl.run(*command, log_failure: false)
       return if st.success?
-
-      debug_msg = <<-DEBUG_MSG.strip_heredoc
-        This usually means template '#{original_filename}' is not a valid Kubernetes template.
-        Error from kubectl:
-          #{err}
-        Rendered template content:
-      DEBUG_MSG
-      debug_msg += File.read(file_path)
-      @logger.summary.add_paragraph(debug_msg)
-
-      raise FatalDeploymentError, "Kubectl dry run failed (command: #{Shellwords.join(command)})"
+      record_invalid_template(err, file_paths: [file_path], original_filenames: [original_filename])
+      raise FatalDeploymentError, "Template validation failed (command: #{Shellwords.join(command)})"
     end
 
     def split_templates(filename)
@@ -270,20 +256,28 @@ module KubernetesDeploy
       raise FatalDeploymentError, "Template '#{filename}' cannot be parsed"
     end
 
-    def record_apply_failure(err)
-      file_content = find_bad_file_from_kubectl_output(err)
-      debug_msg = <<-HELPFUL_MESSAGE.strip_heredoc
-        This usually means one of your templates is invalid.
-        Error from kubectl:
-          #{err}
-      HELPFUL_MESSAGE
-      if file_content
-        debug_msg += "Rendered template content:\n#{file_content}"
+    def record_invalid_template(err, file_paths:, original_filenames: nil)
+      template_names = Array(original_filenames)
+      file_content = Array(file_paths).each_with_object([]) do |file_path, contents|
+        next unless File.file?(file_path)
+        contents << File.read(file_path)
+        template_names << File.basename(file_path) unless original_filenames
+      end.join("\n")
+      template_list = template_names.compact.join(", ").presence || "See error message"
+
+      debug_msg = ColorizedString.new("Invalid #{'template'.pluralize(template_names.length)}: #{template_list}\n").red
+      debug_msg += "> Error from kubectl:\n#{indent_four(err)}"
+      if file_content.present?
+        debug_msg += "\n> Rendered template content:\n#{indent_four(file_content)}"
       end
 
       @logger.summary.add_paragraph(debug_msg)
     end
 
+    def indent_four(str)
+      "    " + str.gsub("\n", "\n    ")
+    end
+
     def wait_for_completion(watched_resources, started_at)
       watcher = ResourceWatcher.new(watched_resources, logger: @logger, deploy_started_at: started_at)
       watcher.run
@@ -407,7 +401,11 @@ module KubernetesDeploy
       if st.success?
         log_pruning(out) if prune
       else
-        record_apply_failure(err)
+        file_paths = find_bad_files_from_kubectl_output(err)
+        warn_msg = "WARNING: Any resources not mentioned in the error below were likely created/updated. " \
+          "You may wish to roll back this deploy."
+        @logger.summary.add_paragraph(ColorizedString.new(warn_msg).yellow)
+        record_invalid_template(err, file_paths: file_paths)
         raise FatalDeploymentError, "Command failed: #{Shellwords.join(command)}"
       end
     end

data/lib/kubernetes-deploy/version.rb

@@ -1,3 +1,3 @@
 module KubernetesDeploy
-  VERSION = "0.9.3"
+  VERSION = "0.9.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-deploy
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Katrina Verey