kubernetes-deploy 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b83794f813d2a4f1b2b3aba98a9181fc2c041f85
-  data.tar.gz: 1d0dc0a38cdd5a44adb1e914751cea41dd8dbce1
+  metadata.gz: 2b7eaf966de6685ee13686190feda92f7d5e249c
+  data.tar.gz: 7bc442ae69145779cd8965caababf22545a5d954
 SHA512:
-  metadata.gz: 82153cb31bd8108540cdbe92fe25d25e6c4d09e3f9781c00f74f664ca2ea1a5fa65311bd940565ea5b7fefa9ec4bcae36f533855cc6f068b4970c3ecf9e06478
-  data.tar.gz: 30fbefaae8d80f503ec2e31664a4ee29097ee80a92f9d398d6ce4e1e76d0f350855fd85048ae6ae7d1fb8932abf6be48b754d4e569626ae0a52e3fb716f54e6b
+  metadata.gz: 983f99b3be92381d2838bc7b7cd4d9efd4220e9b13cd68d795d1d5523cd550d15effea7da8dc273d6dec8825e23372a63ff82a05e577ebcbdac0a3c2b9c2095b
+  data.tar.gz: 28eb00deaa911348e3d27be549bcd0c788e8efc00977edd1c3986521b9e82367b06a8d80a258a371ec9dcd9d4b9dc7100d6e4856f0f98596fd2ab2b43dfd005b

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 0.14.1
+*Bug Fixes*
+- Make deployments whose pods crash because of CreateContainerConfigError fail fast in 1.8+ too (they would previously time out).
+- Fix crashes when deploying ExternalName services or services without selectors ([#211](https://github.com/Shopify/kubernetes-deploy/pull/211))
+- Predeploy ServiceAccount resources ([#221](https://github.com/Shopify/kubernetes-deploy/pull/221))
+
+*Enhancements*
+- Make it possible to pass bindings (via the --bindings flag) for which the value contains commas or is a JSON encoded hash ([#219](https://github.com/Shopify/kubernetes-deploy/pull/219))
+- Support KUBECONFIG referencing multiple files ([#222](https://github.com/Shopify/kubernetes-deploy/pull/222))
+
 ### 0.14.0
 *Bug Fixes*
 - Fix incorrect timeouts occasionally observed on deployments using progressDeadlineSeconds in Kubernetes <1.7.7

data/README.md

@@ -91,7 +91,7 @@ This repo also includes related tools for [running tasks](#kubernetes-run) and [
 *Environment variables:*
 
 - `$REVISION` **(required)**: the SHA of the commit you are deploying. Will be exposed to your ERB templates as `current_sha`.
-- `$KUBECONFIG`  **(required)**: points to a valid kubeconfig file that includes the context you want to deploy to
+- `$KUBECONFIG`  **(required)**: points to one or multiple valid kubeconfig files that include the context you want to deploy to. File names are separated by colon for Linux and Mac, and semi-colon for Windows.
 - `$ENVIRONMENT`: used to set the deploy directory to `config/deploy/$ENVIRONMENT`. You can use the `--template-dir=DIR` option instead if you prefer (**one or the other is required**).
 - `$GOOGLE_APPLICATION_CREDENTIALS`: points to the credentials for an authenticated service account (required if your kubeconfig `user`'s auth provider is GCP)
 

data/exe/kubernetes-deploy

@@ -12,13 +12,9 @@ bindings = {}
 verbose_log_prefix = false
 
 ARGV.options do |opts|
-  opts.on("--bindings=BINDINGS", Array, "Expose additional variables to ERB templates (format: k1=v1,k2=v2)") do |binds|
-    bindings = binds.each_with_object({}) do |bind, acc|
-      k, v = bind.split('=')
-      raise "key for value #{v} is blank!" if k.blank?
-      raise "value for key #{k} is blank!" if v.blank?
-      acc[k] = v
-    end
+  opts.on("--bindings=BINDINGS", "Expose additional variables to ERB templates " \
+    "(format: k1=v1,k2=v2 or JSON)") do |binds|
+    bindings = KubernetesDeploy::BindingsParser.parse(binds)
   end
 
   opts.on("--skip-wait", "Skip verification of non-priority-resource success (not recommended)") { skip_wait = true }

data/lib/kubernetes-deploy.rb

@@ -16,6 +16,7 @@ require 'kubernetes-deploy/formatted_logger'
 require 'kubernetes-deploy/deploy_task'
 require 'kubernetes-deploy/statsd'
 require 'kubernetes-deploy/concurrency'
+require 'kubernetes-deploy/bindings_parser'
 
 module KubernetesDeploy
   KubernetesDeploy::StatsD.build

data/lib/kubernetes-deploy/bindings_parser.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require 'json'
+require 'csv'
+
+module KubernetesDeploy
+  module BindingsParser
+    extend self
+
+    def parse(string)
+      bindings = parse_json(string) || parse_csv(string)
+
+      unless bindings
+        raise ArgumentError, "Failed to parse bindings."
+      end
+
+      bindings
+    end
+
+    private
+
+    def parse_json(string)
+      bindings = JSON.parse(string)
+
+      unless bindings.is_a?(Hash)
+        raise ArgumentError, "Expected JSON data to be a hash."
+      end
+
+      bindings
+    rescue JSON::ParserError
+      nil
+    end
+
+    def parse_csv(string)
+      lines = CSV.parse(string)
+      bindings = {}
+
+      lines.each do |line|
+        line.each do |binding|
+          key, value = binding.split('=', 2)
+
+          if key.blank?
+            raise ArgumentError, "key is blank"
+          end
+
+          bindings[key] = value
+        end
+      end
+
+      bindings
+    rescue CSV::MalformedCSVError
+      nil
+    end
+  end
+end

data/lib/kubernetes-deploy/deploy_task.rb

@@ -48,6 +48,7 @@ module KubernetesDeploy
       Bugsnag
       ConfigMap
       PersistentVolumeClaim
+      ServiceAccount
       Pod
     )
     PROTECTED_NAMESPACES = %w(
@@ -277,8 +278,14 @@ module KubernetesDeploy
       errors = []
       if ENV["KUBECONFIG"].blank?
         errors << "$KUBECONFIG not set"
-      elsif !File.file?(ENV["KUBECONFIG"])
-        errors << "Kube config not found at #{ENV['KUBECONFIG']}"
+      elsif config_files.empty?
+        errors << "Kube config file name(s) not set in $KUBECONFIG"
+      else
+        config_files.each do |f|
+          unless File.file?(f)
+            errors << "Kube config not found at #{f}"
+          end
+        end
       end
 
       if @current_sha.blank?

data/lib/kubernetes-deploy/kubeclient_builder.rb

@@ -6,7 +6,8 @@ module KubernetesDeploy
   module KubeclientBuilder
     class ContextMissingError < FatalDeploymentError
       def initialize(context_name)
-        super("`#{context_name}` context must be configured in your KUBECONFIG (#{ENV['KUBECONFIG']}).")
+        super("`#{context_name}` context must be configured in your " \
+          "KUBECONFIG file(s) (#{ENV['KUBECONFIG']}).")
       end
     end
 
@@ -44,10 +45,12 @@ module KubernetesDeploy
     end
 
     def _build_kubeclient(api_version:, context:, endpoint_path: nil)
-      config = GoogleFriendlyConfig.read(ENV.fetch("KUBECONFIG"))
-      unless config.contexts.include?(context)
-        raise ContextMissingError, context
-      end
+      # Find a context defined in kube conf files that matches the input context by name
+      friendly_configs = config_files.map { |f| GoogleFriendlyConfig.read(f) }
+      config = friendly_configs.find { |c| c.contexts.include?(context) }
+
+      raise ContextMissingError, context unless config
+
       kube_context = config.context(context)
 
       client = Kubeclient::Client.new(
@@ -59,5 +62,10 @@ module KubernetesDeploy
       client.discover
       client
     end
+
+    def config_files
+      # Split the list by colon for Linux and Mac, and semicolon for Windows.
+      ENV.fetch("KUBECONFIG").split(/[:;]/).map!(&:strip).reject(&:empty?)
+    end
   end
 end

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

@@ -202,9 +202,11 @@ module KubernetesDeploy
           "Failed to pull image #{@image}. "\
           "Did you wait for it to be built and pushed to the registry before deploying?"
         elsif limbo_message == "Generate Container Config Failed"
-          # reason/message are backwards
-          # Flip this after https://github.com/kubernetes/kubernetes/commit/df41787b1a3f51b73fb6db8a2203f0a7c7c92931
+          # reason/message are backwards in <1.8.0 (next condition used by 1.8.0+)
+          # Fixed by https://github.com/kubernetes/kubernetes/commit/df41787b1a3f51b73fb6db8a2203f0a7c7c92931
           "Failed to generate container configuration: #{limbo_reason}"
+        elsif limbo_reason == "CreateContainerConfigError"
+          "Failed to generate container configuration: #{limbo_message}"
         end
       end
 

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

@@ -11,7 +11,9 @@ module KubernetesDeploy
     end
 
     def status
-      if @num_pods_selected.blank?
+      if !requires_endpoints?
+        "Doesn't require any endpoint"
+      elsif @num_pods_selected.blank?
         "Failed to count related pods"
       elsif selects_some_pods?
         "Selects at least 1 pod"
@@ -21,6 +23,7 @@ module KubernetesDeploy
     end
 
     def deploy_succeeded?
+      return exists? unless requires_endpoints?
       # We can't use endpoints if we want the service to be able to fail fast when the pods are down
       exposes_zero_replica_deployment? || selects_some_pods?
     end
@@ -44,22 +47,34 @@ module KubernetesDeploy
       @related_deployment_replicas == 0
     end
 
+    def requires_endpoints?
+      # service of type External don't have endpoints
+      return false if external_name_svc?
+
+      # problem counting replicas - by default, assume endpoints are required
+      return true if @related_deployment_replicas.blank?
+
+      @related_deployment_replicas > 0
+    end
+
     def selects_some_pods?
       return false unless @num_pods_selected
       @num_pods_selected > 0
     end
 
     def selector
-      @selector ||= @definition["spec"]["selector"].map { |k, v| "#{k}=#{v}" }.join(",")
+      @selector ||= @definition["spec"].fetch("selector", []).map { |k, v| "#{k}=#{v}" }.join(",")
     end
 
     def fetch_related_pod_count
+      return 0 unless selector.present?
       raw_json, _err, st = kubectl.run("get", "pods", "--selector=#{selector}", "--output=json")
       return unless st.success?
       JSON.parse(raw_json)["items"].length
     end
 
     def fetch_related_replica_count
+      return 0 unless selector.present?
       raw_json, _err, st = kubectl.run("get", "deployments", "--selector=#{selector}", "--output=json")
       return unless st.success?
 
@@ -67,5 +82,9 @@ module KubernetesDeploy
       return unless deployments.length == 1
       deployments.first["spec"]["replicas"].to_i
     end
+
+    def external_name_svc?
+      @definition["spec"]["type"] == "ExternalName"
+    end
   end
 end

data/lib/kubernetes-deploy/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module KubernetesDeploy
-  VERSION = "0.14.0"
+  VERSION = "0.14.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-deploy
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Katrina Verey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2017-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -223,6 +223,7 @@ files:
 - exe/kubernetes-run
 - kubernetes-deploy.gemspec
 - lib/kubernetes-deploy.rb
+- lib/kubernetes-deploy/bindings_parser.rb
 - lib/kubernetes-deploy/concurrency.rb
 - lib/kubernetes-deploy/deferred_summary_logging.rb
 - lib/kubernetes-deploy/deploy_task.rb