kubernetes-deploy 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0ae7839357ce28f77a544c170be1e439515205c
-  data.tar.gz: 945483435a69d88450f060d2a544cb046f93a17d
+  metadata.gz: 820602ac9a434949fb86a0f1cb85996962d4ecb2
+  data.tar.gz: 492b43ccf6a0683b93cc3b187c6711e9bdb176b1
 SHA512:
-  metadata.gz: cc67d2dbc4ea9563f84bd11ae7c991144a0153223f21d07d14e6ad632396167d978c7a9a881386dc1a9a55756a5e06e4e9e60a1b1534b20b4705b4f38fb4d0a4
-  data.tar.gz: df05433e91bc432c9e7412c4806dbdfe4d5ba494763a0e4dfaf6ea6231ed1b1596c6e9dc4157e40f8dcf8857db828cbec9b098244964d147bcc84a2ce74c254e
+  metadata.gz: 23706dd66b3844c4b6fece858621bf4b9cea5c0c65568b972cb6afdfab64a1f8d45957c7095a3ca8af96f9c488f383f2f1fd69d99d5affdbf9545d9c0c7ac948
+  data.tar.gz: 64bf0d15a51c97be05e80a3b64b0e3f985f0f6a0bd137fbd1e6353b13bec404e6dd150a66f34c15f0f24cfee66a1838efba2d6260bf6ece9bf5c4c0903e55e12

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-### 0.17.1
+### 0.18.1
+*Enhancements*
+- Change the way the resource watcher fetches resources to make it more efficient for large deploys. Deploys with hundreds of resources are expected to see a measurable performance improvement from this change. ([#251](https://github.com/Shopify/kubernetes-deploy/pull/251))
+
+### 0.18.0
 *Features*
 - kubernetes-restart and kubernetes-deploy use exit code 70 when a
 deploy fails due to one or more resources failing to deploy in time.

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,25 @@
+<!-- Please erase any parts of this template not applicable to your issue. -->
+
+# Bug report
+
+[Description of the bug]
+
+**Expected behavior:** [What you expected to happen]
+
+**Actual behavior:** [What actually happened]
+
+**Version(s) affected:** [run `kubernetes-deploy --version`]
+
+### Steps to Reproduce
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+# Feature request
+
+- [ ] If the maintainers agree with the feature as described here, I intend to submit a Pull Request myself.<sup>1</sup>
+
+**Proposal:** [provide details on the behaviour you'd like to see and why it would be useful]
+
+<sup><small>1</small></sup> <sub>This is the quickest way to get a new feature! We reserve the right to close feature requests, even ones we like, if the proposer does not intend to contribute to the feature and it doesn't fit in our current roadmap.</sub>

data/README.md

@@ -121,7 +121,7 @@ All templates must be YAML formatted. You can also use ERB. The following local
 * `current_sha`: The value of `$REVISION`
 * `deployment_id`:  A randomly generated identifier for the deploy. Useful for creating unique names for task-runner pods (e.g. a pod that runs rails migrations at the beginning of deploys).
 
-You can add additional variables using the `--bindings=BINDINGS` option. For example, `kubernetes-deploy my-app cluster1 --bindings=color=blue,size=large` will expose `color` and `size` in your templates.
+You can add additional variables using the `--bindings=BINDINGS` option which can be formated as comma separated or as JSON. For example, `kubernetes-deploy my-app cluster1 --bindings=color=blue,size=large` or `kubernetes-deploy my-app cluster1 --bindings='{"color":"blue","size":"large"}'` will expose `color` and `size` in your templates. Complex JSON data will be converted to a Hash for use in templates.
 
 #### Using partials
 
@@ -427,10 +427,9 @@ This gem uses subclasses of `KubernetesResource` to implement custom success/fai
 
 1. Create a the file for your type in `lib/kubernetes-deploy/kubernetes_resource/`
 2. Create a new class that inherits from `KubernetesResource`. Minimally, it should implement the following methods:
-    * `sync` -- gather/update the data you'll need to determine `deploy_succeeded?` and `deploy_failed?`
+    * `sync` -- Gather the data you'll need to determine `deploy_succeeded?` and `deploy_failed?`. The superclass's implementation fetches the corresponding resource, parses it and stores it in `@instance_data`. You can define your own implementation if you need something else.
     * `deploy_succeeded?`
     * `deploy_failed?`
-    * `exists?`
 3. Adjust the `TIMEOUT` constant to an appropriate value for this type.
 4. Add the a basic example of the type to the hello-cloud [fixture set](https://github.com/Shopify/kubernetes-deploy/tree/master/test/fixtures/hello-cloud) and appropriate assertions to `#assert_all_up` in [`hello_cloud.rb`](https://github.com/Shopify/kubernetes-deploy/blob/master/test/helpers/fixture_sets/hello_cloud.rb). This will get you coverage in several existing tests, such as `test_full_hello_cloud_set_deploy_succeeds`.
 5. Add tests for any edge cases you foresee.

data/lib/kubernetes-deploy.rb

@@ -19,6 +19,7 @@ require 'kubernetes-deploy/statsd'
 require 'kubernetes-deploy/concurrency'
 require 'kubernetes-deploy/bindings_parser'
 require 'kubernetes-deploy/duration_parser'
+require 'kubernetes-deploy/sync_mediator'
 
 module KubernetesDeploy
   MIN_KUBE_VERSION = '1.7.0'

data/lib/kubernetes-deploy/deploy_task.rb

@@ -16,7 +16,6 @@ require 'kubernetes-deploy/kubernetes_resource'
   memcached
   service
   pod_template
-  bugsnag
   pod_disruption_budget
   replica_set
   service_account
@@ -46,7 +45,6 @@ module KubernetesDeploy
       Cloudsql
       Redis
       Memcached
-      Bugsnag
       ConfigMap
       PersistentVolumeClaim
       ServiceAccount
@@ -103,6 +101,7 @@ module KubernetesDeploy
         logger: @logger,
         bindings: bindings,
       )
+      @sync_mediator = SyncMediator.new(namespace: @namespace, context: @context, logger: @logger)
     end
 
     def run(*args)
@@ -124,7 +123,7 @@ module KubernetesDeploy
       validate_definitions(resources)
 
       @logger.phase_heading("Checking initial resource statuses")
-      KubernetesDeploy::Concurrency.split_across_threads(resources, &:sync)
+      @sync_mediator.sync(resources)
       resources.each { |r| @logger.info(r.pretty_status) }
 
       ejson = EjsonSecretProvisioner.new(
@@ -207,6 +206,9 @@ module KubernetesDeploy
         failed_resources = matching_resources.reject(&:deploy_succeeded?)
         fail_count = failed_resources.length
         if fail_count > 0
+          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) }
           raise FatalDeploymentError, "Failed to deploy #{fail_count} priority #{'resource'.pluralize(fail_count)}"
         end
@@ -215,7 +217,7 @@ module KubernetesDeploy
     end
 
     def validate_definitions(resources)
-      KubernetesDeploy::Concurrency.split_across_threads(resources, &:validate_definition)
+      KubernetesDeploy::Concurrency.split_across_threads(resources) { |r| r.validate_definition(kubectl) }
       failed_resources = resources.select(&:validation_failed?)
       return unless failed_resources.present?
 
@@ -373,7 +375,8 @@ module KubernetesDeploy
       apply_all(applyables, prune)
 
       if verify
-        watcher = ResourceWatcher.new(resources, logger: @logger, deploy_started_at: deploy_started_at)
+        watcher = ResourceWatcher.new(resources: resources, sync_mediator: @sync_mediator,
+          logger: @logger, deploy_started_at: deploy_started_at)
         watcher.run(record_summary: record_summary)
       end
     end

data/lib/kubernetes-deploy/kubernetes_resource.rb

@@ -2,7 +2,6 @@
 require 'json'
 require 'open3'
 require 'shellwords'
-require 'kubernetes-deploy/kubectl'
 
 module KubernetesDeploy
   class KubernetesResource
@@ -28,20 +27,26 @@ module KubernetesDeploy
 
     TIMEOUT_OVERRIDE_ANNOTATION = "kubernetes-deploy.shopify.io/timeout-override"
 
-    def self.build(namespace:, context:, definition:, logger:)
-      opts = { namespace: namespace, context: context, definition: definition, logger: logger }
-      if KubernetesDeploy.const_defined?(definition["kind"])
-        klass = KubernetesDeploy.const_get(definition["kind"])
-        klass.new(**opts)
-      else
-        inst = new(**opts)
-        inst.type = definition["kind"]
-        inst
+    class << self
+      def build(namespace:, context:, definition:, logger:)
+        opts = { namespace: namespace, context: context, definition: definition, logger: logger }
+        if KubernetesDeploy.const_defined?(definition["kind"])
+          klass = KubernetesDeploy.const_get(definition["kind"])
+          klass.new(**opts)
+        else
+          inst = new(**opts)
+          inst.type = definition["kind"]
+          inst
+        end
+      end
+
+      def timeout
+        self::TIMEOUT
       end
-    end
 
-    def self.timeout
-      self::TIMEOUT
+      def kind
+        name.demodulize
+      end
     end
 
     def timeout
@@ -74,9 +79,10 @@ module KubernetesDeploy
       @definition = definition
       @statsd_report_done = false
       @validation_errors = []
+      @instance_data = {}
     end
 
-    def validate_definition
+    def validate_definition(kubectl)
       @validation_errors = []
       validate_timeout_annotation
 
@@ -103,7 +109,8 @@ module KubernetesDeploy
       file.path
     end
 
-    def sync
+    def sync(mediator)
+      @instance_data = mediator.get_instance(type, name)
     end
 
     def deploy_failed?
@@ -115,7 +122,8 @@ module KubernetesDeploy
     end
 
     def deploy_succeeded?
-      if deploy_started? && !@success_assumption_warning_shown
+      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
@@ -123,15 +131,15 @@ module KubernetesDeploy
     end
 
     def exists?
-      nil
+      @instance_data.present?
     end
 
     def status
-      @status ||= "Unknown"
+      exists? ? "Exists" : "Unknown"
     end
 
     def type
-      @type || self.class.name.demodulize
+      @type || self.class.kind
     end
 
     def deploy_timed_out?
@@ -144,15 +152,13 @@ module KubernetesDeploy
       :apply
     end
 
-    def sync_debug_info
-      @events = fetch_events unless ENV[DISABLE_FETCHING_EVENT_INFO]
-      @logs = fetch_logs if supports_logs? && !ENV[DISABLE_FETCHING_EVENT_INFO]
+    def sync_debug_info(kubectl)
+      @events = fetch_events(kubectl) unless ENV[DISABLE_FETCHING_EVENT_INFO]
+      @logs = fetch_logs(kubectl) if supports_logs? && !ENV[DISABLE_FETCHING_EVENT_INFO]
       @debug_info_synced = true
     end
 
     def debug_message
-      sync_debug_info unless @debug_info_synced
-
       helpful_info = []
       if deploy_failed?
         helpful_info << ColorizedString.new("#{id}: FAILED").red
@@ -210,9 +216,10 @@ module KubernetesDeploy
     #     "Pulled: Successfully pulled image "hello-world:latest" (1 events)"
     #   ]
     # }
-    def fetch_events
+    def fetch_events(kubectl)
       return {} unless exists?
-      out, _err, st = kubectl.run("get", "events", "--output=go-template=#{Event.go_template_for(type, name)}")
+      out, _err, st = kubectl.run("get", "events", "--output=go-template=#{Event.go_template_for(type, name)}",
+        log_failure: false)
       return {} unless st.success?
 
       event_collector = Hash.new { |hash, key| hash[key] = [] }
@@ -230,12 +237,7 @@ module KubernetesDeploy
 
     def pretty_status
       padding = " " * [50 - id.length, 1].max
-      msg = exists? ? status : "not found"
-      "#{id}#{padding}#{msg}"
-    end
-
-    def kubectl
-      @kubectl ||= Kubectl.new(namespace: @namespace, context: @context, logger: @logger, log_failure_by_default: false)
+      "#{id}#{padding}#{status}"
     end
 
     def report_status_to_statsd(watch_time)

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

@@ -1,11 +1,6 @@
 # frozen_string_literal: true
 module KubernetesDeploy
   class Bucket < KubernetesResource
-    def sync
-      _, _err, st = kubectl.run("get", type, @name)
-      @found = st.success?
-    end
-
     def deploy_succeeded?
       return false unless deploy_started?
 
@@ -16,8 +11,8 @@ module KubernetesDeploy
       true
     end
 
-    def exists?
-      @found
+    def status
+      exists? ? "Available" : "Unknown"
     end
 
     def deploy_failed?

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

@@ -3,75 +3,46 @@ module KubernetesDeploy
   class Cloudsql < KubernetesResource
     TIMEOUT = 10.minutes
 
-    def sync
-      _, _err, st = kubectl.run("get", type, @name)
-      @found = st.success?
-      @deployment_exists = cloudsql_proxy_deployment_exists?
-      @service_exists = mysql_service_exists?
-      @status = if @deployment_exists && @service_exists
-        "Provisioned"
-      else
-        "Unknown"
-      end
+    SYNC_DEPENDENCIES = %w(Deployment Service)
+    def sync(mediator)
+      super
+      @proxy_deployment = mediator.get_instance(Deployment.kind, "cloudsql-#{cloudsql_resource_uuid}")
+      @proxy_service = mediator.get_instance(Service.kind, "cloudsql-#{@name}")
+    end
+
+    def status
+      deploy_succeeded? ? "Provisioned" : "Unknown"
     end
 
     def deploy_succeeded?
-      @service_exists && @deployment_exists
+      proxy_deployment_ready? && proxy_service_ready?
     end
 
     def deploy_failed?
       false
     end
 
-    def exists?
-      @found
-    end
-
     def deploy_method
       :replace
     end
 
     private
 
-    def cloudsql_proxy_deployment_exists?
-      deployment, _err, st = kubectl.run("get", "deployments", "cloudsql-#{cloudsql_resource_uuid}", "-o=json")
-
-      if st.success?
-        parsed = JSON.parse(deployment)
-
-        if parsed.fetch("status", {}).fetch("availableReplicas", -1) == parsed.fetch("status", {}).fetch("replicas", 0)
-          # all cloudsql-proxy pods are running
-          return true
-        end
-      end
-
-      false
+    def proxy_deployment_ready?
+      return false unless status = @proxy_deployment["status"]
+      # all cloudsql-proxy pods are running
+      status.fetch("availableReplicas", -1) == status.fetch("replicas", 0)
     end
 
-    def mysql_service_exists?
-      service, _err, st = kubectl.run("get", "services", "cloudsql-#{@name}", "-o=json")
-
-      if st.success?
-        parsed = JSON.parse(service)
-
-        if parsed.dig("spec", "clusterIP").present?
-          # the service has an assigned cluster IP and is therefore functioning
-          return true
-        end
-      end
-
-      false
+    def proxy_service_ready?
+      return false unless @proxy_service.present?
+      # the service has an assigned cluster IP and is therefore functioning
+      @proxy_service.dig("spec", "clusterIP").present?
     end
 
     def cloudsql_resource_uuid
-      return @cloudsql_resource_uuid if defined?(@cloudsql_resource_uuid) && @cloudsql_resource_uuid
-
-      cloudsql, _err, st = kubectl.run("get", "cloudsqls", @name, "-o=json")
-      if st.success?
-        parsed = JSON.parse(cloudsql)
-
-        @cloudsql_resource_uuid = parsed.dig("metadata", "uid")
-      end
+      return unless @instance_data
+      @instance_data.dig("metadata", "uid")
     end
   end
 end

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

@@ -3,16 +3,14 @@ module KubernetesDeploy
   class ConfigMap < KubernetesResource
     TIMEOUT = 30.seconds
 
-    def sync
-      _, _err, st = kubectl.run("get", type, @name)
-      @status = st.success? ? "Available" : "Unknown"
-      @found = st.success?
-    end
-
     def deploy_succeeded?
       exists?
     end
 
+    def status
+      exists? ? "Available" : "Unknown"
+    end
+
     def deploy_failed?
       false
     end
@@ -20,9 +18,5 @@ module KubernetesDeploy
     def timeout_message
       UNUSUAL_FAILURE_MESSAGE
     end
-
-    def exists?
-      @found
-    end
   end
 end

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

@@ -3,12 +3,6 @@ module KubernetesDeploy
   class CronJob < KubernetesResource
     TIMEOUT = 30.seconds
 
-    def sync
-      _, _err, st = kubectl.run("get", type, @name)
-      @status = st.success? ? "Available" : "Unknown"
-      @found = st.success?
-    end
-
     def deploy_succeeded?
       exists?
     end
@@ -20,9 +14,5 @@ module KubernetesDeploy
     def timeout_message
       UNUSUAL_FAILURE_MESSAGE
     end
-
-    def exists?
-      @found
-    end
   end
 end