kubernetes-deploy 0.18.0 → 0.18.1

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

@@ -3,18 +3,18 @@ module KubernetesDeploy
   class Service < KubernetesResource
     TIMEOUT = 7.minutes
 
-    def sync
-      _, _err, st = kubectl.run("get", type, @name)
-      @found = st.success?
-      @related_deployment_replicas = fetch_related_replica_count
-      @num_pods_selected = fetch_related_pod_count
+    SYNC_DEPENDENCIES = %w(Pod Deployment)
+    def sync(mediator)
+      super
+      @related_deployments = selector.present? ? mediator.get_all(Deployment.kind, selector) : []
+      @related_pods = selector.present? ? mediator.get_all(Pod.kind, selector) : []
     end
 
     def status
-      if !requires_endpoints?
-        "Doesn't require any endpoint"
-      elsif @num_pods_selected.blank?
-        "Failed to count related pods"
+      if !exists?
+        "Not found"
+      elsif !requires_endpoints?
+        "Doesn't require any endpoints"
       elsif selects_some_pods?
         "Selects at least 1 pod"
       else
@@ -23,6 +23,7 @@ module KubernetesDeploy
     end
 
     def deploy_succeeded?
+      return false unless exists?
       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?
@@ -36,15 +37,11 @@ module KubernetesDeploy
       "This service does not seem to select any pods. This means its spec.selector is probably incorrect."
     end
 
-    def exists?
-      @found
-    end
-
     private
 
     def exposes_zero_replica_deployment?
-      return false unless @related_deployment_replicas
-      @related_deployment_replicas == 0
+      return false unless related_replica_count
+      related_replica_count == 0
     end
 
     def requires_endpoints?
@@ -52,35 +49,24 @@ module KubernetesDeploy
       return false if external_name_svc?
 
       # problem counting replicas - by default, assume endpoints are required
-      return true if @related_deployment_replicas.blank?
+      return true if related_replica_count.blank?
 
-      @related_deployment_replicas > 0
+      related_replica_count > 0
     end
 
     def selects_some_pods?
-      return false unless @num_pods_selected
-      @num_pods_selected > 0
+      return false unless selector.present?
+      @related_pods.present?
     end
 
     def selector
-      @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
+      @definition["spec"].fetch("selector", {})
     end
 
-    def fetch_related_replica_count
+    def related_replica_count
       return 0 unless selector.present?
-      raw_json, _err, st = kubectl.run("get", "deployments", "--selector=#{selector}", "--output=json")
-      return unless st.success?
-
-      deployments = JSON.parse(raw_json)["items"]
-      return unless deployments.length == 1
-      deployments.first["spec"]["replicas"].to_i
+      return unless @related_deployments.length == 1
+      @related_deployments.first["spec"]["replicas"].to_i
     end
 
     def external_name_svc?

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

@@ -3,10 +3,8 @@ module KubernetesDeploy
   class ServiceAccount < KubernetesResource
     TIMEOUT = 30.seconds
 
-    def sync
-      _, _err, st = kubectl.run("get", type, @name, "--output=json")
-      @status = st.success? ? "Created" : "Unknown"
-      @found = st.success?
+    def status
+      exists? ? "Created" : "Unknown"
     end
 
     def deploy_succeeded?
@@ -17,10 +15,6 @@ module KubernetesDeploy
       false
     end
 
-    def exists?
-      @found
-    end
-
     def timeout_message
       UNUSUAL_FAILURE_MESSAGE
     end

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

@@ -6,31 +6,21 @@ module KubernetesDeploy
     ONDELETE = 'OnDelete'
     attr_reader :pods
 
-    def sync
-      raw_json, _err, st = kubectl.run("get", type, @name, "--output=json")
-      @found = st.success?
+    SYNC_DEPENDENCIES = %w(Pod)
+    def sync(mediator)
+      super
+      @pods = exists? ? find_pods(mediator) : []
+      @server_version ||= mediator.kubectl.server_version
+    end
 
-      if @found
-        stateful_data = JSON.parse(raw_json)
-        @desired_replicas = stateful_data["spec"]["replicas"].to_i
-        @status_data = stateful_data["status"]
-        rollout_data = stateful_data["status"].slice("replicas", "readyReplicas", "currentReplicas")
-        @update_strategy = if kubectl.server_version < Gem::Version.new("1.7.0")
-          ONDELETE
-        else
-          stateful_data['spec']['updateStrategy']['type']
-        end
-        @status = rollout_data.map { |state_replicas, num| "#{num} #{state_replicas.chop.pluralize(num)}" }.join(", ")
-        @pods = find_pods(stateful_data)
-      else # reset
-        @status_data = { 'readyReplicas' => '-1', 'currentReplicas' => '-2' }
-        @status = nil
-        @pods = []
-      end
+    def status
+      return super unless @instance_data["status"].present?
+      rollout_data = @instance_data["status"].slice("replicas", "readyReplicas", "currentReplicas")
+      rollout_data.map { |state_replicas, num| "#{num} #{state_replicas.chop.pluralize(num)}" }.join(", ")
     end
 
     def deploy_succeeded?
-      if @update_strategy == ONDELETE
+      if update_strategy == ONDELETE
         # Gem cannot monitor update since it doesn't occur until delete
         unless @success_assumption_warning_shown
           @logger.warn("WARNING: Your StatefulSet's updateStrategy is set to OnDelete, "\
@@ -40,27 +30,43 @@ module KubernetesDeploy
         end
         true
       else
-        @status_data['currentRevision'] == @status_data['updateRevision'] &&
-        @desired_replicas == @status_data['readyReplicas'].to_i &&
-        @desired_replicas == @status_data['currentReplicas'].to_i
+        status_data['currentRevision'] == status_data['updateRevision'] &&
+        desired_replicas == status_data['readyReplicas'].to_i &&
+        desired_replicas == status_data['currentReplicas'].to_i
       end
     end
 
     def deploy_failed?
-      return false if @update_strategy == ONDELETE
+      return false if update_strategy == ONDELETE
       pods.present? && pods.any?(&:deploy_failed?)
     end
 
-    def exists?
-      @found
+    private
+
+    def update_strategy
+      if @server_version < Gem::Version.new("1.7.0")
+        ONDELETE
+      elsif exists?
+        @instance_data['spec']['updateStrategy']['type']
+      else
+        'Unknown'
+      end
     end
 
-    private
+    def status_data
+      return { 'readyReplicas' => '-1', 'currentReplicas' => '-2' } unless exists?
+      @instance_data["status"]
+    end
+
+    def desired_replicas
+      return -1 unless exists?
+      @instance_data["spec"]["replicas"].to_i
+    end
 
-    def parent_of_pod?(set_data, pod_data)
+    def parent_of_pod?(pod_data)
       return false unless pod_data.dig("metadata", "ownerReferences")
-      pod_data["metadata"]["ownerReferences"].any? { |ref| ref["uid"] == set_data["metadata"]["uid"] } &&
-      set_data["status"]["currentRevision"] == pod_data["metadata"]["labels"]["controller-revision-hash"]
+      pod_data["metadata"]["ownerReferences"].any? { |ref| ref["uid"] == @instance_data["metadata"]["uid"] } &&
+      @instance_data["status"]["currentRevision"] == pod_data["metadata"]["labels"]["controller-revision-hash"]
     end
   end
 end

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

@@ -1,23 +1,8 @@
 # frozen_string_literal: true
 module KubernetesDeploy
   class Statefulservice < KubernetesResource
-    def sync
-      _, _err, st = kubectl.run("get", type, @name)
-      @found = st.success?
-    end
-
     def deploy_succeeded?
-      return false unless deploy_started?
-
-      unless @success_assumption_warning_shown
-        @logger.warn("Don't know how to monitor resources of type #{type}. Assuming #{id} deployed successfully.")
-        @success_assumption_warning_shown = true
-      end
-      true
-    end
-
-    def exists?
-      @found
+      super # success assumption, with warning
     end
 
     def deploy_failed?

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

@@ -1,23 +1,8 @@
 # frozen_string_literal: true
 module KubernetesDeploy
   class Topic < KubernetesResource
-    def sync
-      _, _err, st = kubectl.run("get", type, @name)
-      @found = st.success?
-    end
-
     def deploy_succeeded?
-      return false unless deploy_started?
-
-      unless @success_assumption_warning_shown
-        @logger.warn("Don't know how to monitor resources of type #{type}. Assuming #{id} deployed successfully.")
-        @success_assumption_warning_shown = true
-      end
-      true
-    end
-
-    def exists?
-      @found
+      super # success assumption, with warning
     end
 
     def deploy_failed?

data/lib/kubernetes-deploy/resource_watcher.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module KubernetesDeploy
   class ResourceWatcher
-    def initialize(resources, logger:, deploy_started_at: Time.now.utc, operation_name: "deploy")
+    def initialize(resources:, sync_mediator:, logger:, deploy_started_at: Time.now.utc, operation_name: "deploy")
       unless resources.is_a?(Enumerable)
         raise ArgumentError, <<~MSG
           ResourceWatcher expects Enumerable collection, got `#{resources.class}` instead
@@ -9,6 +9,7 @@ module KubernetesDeploy
       end
       @resources = resources
       @logger = logger
+      @sync_mediator = sync_mediator
       @deploy_started_at = deploy_started_at
       @operation_name = operation_name
     end
@@ -23,7 +24,7 @@ module KubernetesDeploy
         end
         delay_sync_until = Time.now.utc + delay_sync # don't pummel the API if the sync is fast
 
-        KubernetesDeploy::Concurrency.split_across_threads(remainder, &:sync)
+        @sync_mediator.sync(remainder)
         new_successes, remainder = remainder.partition(&:deploy_succeeded?)
         new_failures, remainder = remainder.partition(&:deploy_failed?)
         new_timeouts, remainder = remainder.partition(&:deploy_timed_out?)
@@ -93,7 +94,9 @@ module KubernetesDeploy
             "failed to #{@operation_name} #{failures.length} #{'resource'.pluralize(failures.length)}"
           )
         end
-        KubernetesDeploy::Concurrency.split_across_threads(failed_resources, &:sync_debug_info)
+        KubernetesDeploy::Concurrency.split_across_threads(failed_resources) do |r|
+          r.sync_debug_info(@sync_mediator.kubectl)
+        end
         failed_resources.each { |r| @logger.summary.add_paragraph(r.debug_message) }
       end
     end

data/lib/kubernetes-deploy/restart_task.rb

@@ -24,6 +24,7 @@ module KubernetesDeploy
       @context = context
       @namespace = namespace
       @logger = logger
+      @sync_mediator = SyncMediator.new(namespace: @namespace, context: @context, logger: @logger)
     end
 
     def perform(*args)
@@ -48,7 +49,8 @@ module KubernetesDeploy
 
       @logger.phase_heading("Waiting for rollout")
       resources = build_watchables(deployments, start)
-      ResourceWatcher.new(resources, logger: @logger, operation_name: "restart").run
+      ResourceWatcher.new(resources: resources, sync_mediator: @sync_mediator,
+        logger: @logger, operation_name: "restart").run
       failed_resources = resources.reject(&:deploy_succeeded?)
       success = failed_resources.empty?
       if !success && failed_resources.all?(&:deploy_timed_out?)

data/lib/kubernetes-deploy/sync_mediator.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+module KubernetesDeploy
+  class SyncMediator
+    def initialize(namespace:, context:, logger:)
+      @namespace = namespace
+      @context = context
+      @logger = logger
+      clear_cache
+    end
+
+    def get_instance(kind, resource_name)
+      if @cache.key?(kind)
+        @cache.dig(kind, resource_name) || {}
+      else
+        request_instance(kind, resource_name)
+      end
+    end
+
+    def get_all(kind, selector = nil)
+      fetch_by_kind(kind) unless @cache.key?(kind)
+      instances = @cache.fetch(kind, {}).values
+      return instances unless selector
+
+      instances.select do |r|
+        labels = r.dig("metadata", "labels") || {}
+        labels >= selector
+      end
+    end
+
+    def sync(resources)
+      clear_cache
+      dependencies = resources.map(&:class).uniq.flat_map do |c|
+        c::SYNC_DEPENDENCIES if c.const_defined?('SYNC_DEPENDENCIES')
+      end
+      kinds = (resources.map(&:type) + dependencies).compact.uniq
+      kinds.each { |kind| fetch_by_kind(kind) }
+
+      KubernetesDeploy::Concurrency.split_across_threads(resources) do |r|
+        r.sync(dup)
+      end
+    end
+
+    def kubectl
+      @kubectl ||= Kubectl.new(namespace: @namespace, context: @context, logger: @logger, log_failure_by_default: false)
+    end
+
+    private
+
+    def clear_cache
+      @cache = {}
+    end
+
+    def request_instance(kind, iname)
+      raw_json, _, st = kubectl.run("get", kind, iname, "-a", "--output=json")
+      st.success? ? JSON.parse(raw_json) : {}
+    end
+
+    def fetch_by_kind(kind)
+      raw_json, _, st = kubectl.run("get", kind, "-a", "--output=json")
+      return unless st.success?
+      @cache[kind] = JSON.parse(raw_json)["items"].each_with_object({}) do |r, instances|
+        instances[r.dig("metadata", "name")] = r
+      end
+    end
+  end
+end

data/lib/kubernetes-deploy/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-deploy
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Katrina Verey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -210,6 +210,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- ISSUE_TEMPLATE.md
 - LICENSE.txt
 - NO-BINAUTH
 - README.md
@@ -237,7 +238,6 @@ files:
 - lib/kubernetes-deploy/kubectl.rb
 - lib/kubernetes-deploy/kubernetes_resource.rb
 - lib/kubernetes-deploy/kubernetes_resource/bucket.rb
-- lib/kubernetes-deploy/kubernetes_resource/bugsnag.rb
 - lib/kubernetes-deploy/kubernetes_resource/cloudsql.rb
 - lib/kubernetes-deploy/kubernetes_resource/config_map.rb
 - lib/kubernetes-deploy/kubernetes_resource/cron_job.rb
@@ -264,6 +264,7 @@ files:
 - lib/kubernetes-deploy/restart_task.rb
 - lib/kubernetes-deploy/runner_task.rb
 - lib/kubernetes-deploy/statsd.rb
+- lib/kubernetes-deploy/sync_mediator.rb
 - lib/kubernetes-deploy/version.rb
 - screenshots/deploy-demo.gif
 - screenshots/migrate-logs.png

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-module KubernetesDeploy
-  class Bugsnag < KubernetesResource
-    TIMEOUT = 1.minute
-
-    def sync
-      @secret_found = false
-      _, _err, st = kubectl.run("get", type, @name)
-      @found = st.success?
-      if @found
-        secrets, _err, _st = kubectl.run("get", "secrets", "--output=name")
-        @secret_found = secrets.split.any? { |s| s.end_with?("-bugsnag") }
-      end
-      @status = @secret_found ? "Available" : "Unknown"
-    end
-
-    def deploy_succeeded?
-      @secret_found
-    end
-
-    def deploy_failed?
-      false
-    end
-
-    def exists?
-      @found
-    end
-
-    def deploy_method
-      :replace
-    end
-  end
-end