Predeploy more resources

README.md

@@ -166,11 +166,11 @@ before the deployment is considered successful.
     - Percent (e.g. 90%): The deploy is successful when the number of new pods that are ready is equal to `spec.replicas` * Percent.
   - _Compatibility_: StatefulSet
     - `full`: The deployment is successful when all pods are ready.
-- `krane.shopify.io/predeployed`: Causes a Custom Resource to be deployed in the pre-deploy phase.
-  - _Compatibility_: Custom Resource Definition
+- `krane.shopify.io/predeployed`: Causes a Custom Resource, Deployment, Service, or Job to be deployed in the pre-deploy phase.
+  - _Compatibility_: Custom Resource Definition, Deployment, Service, Job
   - _Default_: `true`
-  - `true`: The custom resource will be deployed in the pre-deploy phase.
-  - All other values: The custom resource will be deployed in the main deployment phase.
+  - `true`: The custom resource, deployment, service, or job will be deployed in the pre-deploy phase.
+  - All other values: The custom resource, deployment, service, or job will be deployed in the main deployment phase.
 - `krane.shopify.io/deploy-method-override`: Cause a resource to be deployed by the specified `kubectl` command, instead of the default `apply`.
   - _Compatibility_: Cannot be used for `PodDisruptionBudget`, since it always uses `create/replace-force`
   - _Accepted values_: `create`, `replace`, and `replace-force`

lib/krane/cluster_resource_discovery.rb

@@ -18,6 +18,27 @@ def crds
       end
     end
 
+    def services
+      @services ||= fetch_services.map do |svc|
+        Service.new(namespace: namespace, context: context, logger: logger,
+          definition: svc, statsd_tags: @namespace_tags)
+      end
+    end
+
+    def deployments
+      @deployments ||= fetch_deployments.map do |deployment|
+        Deployment.new(namespace: namespace, context: context, logger: logger,
+          definition: deployment, statsd_tags: @namespace_tags)
+      end
+    end
+
+    def jobs
+      @jobs ||= fetch_jobs.map do |job|
+        Job.new(namespace: namespace, context: context, logger: logger,
+          definition: job, statsd_tags: @namespace_tags)
+      end
+    end
+
     def prunable_resources(namespaced:)
       black_list = %w(Namespace Node ControllerRevision Event)
       fetch_resources(namespaced: namespaced).map do |resource|
@@ -98,6 +119,36 @@ def fetch_crds
       end
     end
 
+    def fetch_services
+      raw_json, err, st = kubectl.run("get", "Service", output: "json", attempts: 5,
+        use_namespace: false)
+      if st.success?
+        MultiJson.load(raw_json)["items"]
+      else
+        raise FatalKubeAPIError, "Error retrieving Service: #{err}"
+      end
+    end
+
+    def fetch_deployments
+      raw_json, err, st = kubectl.run("get", "Deployment", output: "json", attempts: 5,
+        use_namespace: false)
+      if st.success?
+        MultiJson.load(raw_json)["items"]
+      else
+        raise FatalKubeAPIError, "Error retrieving Deployment: #{err}"
+      end
+    end
+
+    def fetch_jobs
+      raw_json, err, st = kubectl.run("get", "Job", output: "json", attempts: 5,
+        use_namespace: false)
+      if st.success?
+        MultiJson.load(raw_json)["items"]
+      else
+        raise FatalKubeAPIError, "Error retrieving Job: #{err}"
+      end
+    end
+
     def kubectl
       @kubectl ||= Kubectl.new(task_config: @task_config, log_failure_by_default: true)
     end

lib/krane/deploy_task.rb

@@ -70,7 +70,10 @@ def predeploy_sequence
       ).map { |r| [r, default_group] }
 
       after_crs = %w(
+        Deployment
+        Service
         Pod
+        Job
       ).map { |r| [r, default_group] }
 
       crs = cluster_resource_discoverer.crds.select(&:predeployed?).map { |cr| [cr.kind, { group: cr.group }] }

lib/krane/kubernetes_resource.rb

@@ -381,6 +381,11 @@ def use_generated_name(instance_data)
       @file = create_definition_tempfile
     end
 
+    def predeployed?
+      predeployed = krane_annotation_value("predeployed")
+      predeployed.nil? || predeployed == "false"
+    end
+
     class Event
       EVENT_SEPARATOR = "ENDEVENT--BEGINEVENT"
       FIELD_SEPARATOR = "ENDFIELD--BEGINFIELD"

lib/krane/kubernetes_resource/deployment.rb

@@ -111,6 +111,14 @@ def validate_definition(*, **)
       @validation_errors.empty?
     end
 
+    def predeployed?
+      krane_annotation_value("predeployed") == "true"
+    end
+
+    def kind
+      @definition["kind"]
+    end
+
     private
 
     def current_generation

lib/krane/kubernetes_resource/job.rb

@@ -37,6 +37,14 @@ def failure_message
       end
     end
 
+    def predeployed?
+      krane_annotation_value("predeployed") == "true"
+    end
+
+    def kind
+      @definition["kind"]
+    end
+
     private
 
     def failed_status_condition

lib/krane/kubernetes_resource/service.rb

@@ -44,6 +44,14 @@ def timeout_message
       "Please confirm the spec.selector is correct and the targeted workload is healthy."
     end
 
+    def predeployed?
+      krane_annotation_value("predeployed") == "true"
+    end
+
+    def kind
+      @definition["kind"]
+    end
+
     private
 
     def fetch_related_workloads(cache)

lib/krane/resource_deployer.rb

@@ -49,7 +49,8 @@ def predeploy_priority_resources(resource_list, predeploy_sequence)
       predeploy_sequence.each do |resource_type, attributes|
         matching_resources = resource_list.select do |r|
           r.type == resource_type &&
-          (!attributes[:group] || r.group == attributes[:group])
+          (!attributes[:group] || r.group == attributes[:group]) &&
+          r.predeployed?
         end
         StatsD.client.gauge('priority_resources.count', matching_resources.size, tags: statsd_tags)
 

test/helpers/mock_resource.rb

@@ -25,6 +25,10 @@ def group
     "core"
   end
 
+  def predeployed?
+    false
+  end
+
   def pretty_timeout_type
   end
 

test/integration-serial/serial_deploy_test.rb

@@ -344,8 +344,7 @@ def test_cr_success_with_service
 
     assert_deploy_success(deploy_fixtures("crd", subset: %w(web.yml)))
 
-    refute_logs_match(/Predeploying priority resources/)
-    assert_logs_match_all([/Phase 3: Deploying all resources/])
+    assert_logs_match_all([/Phase 4: Deploying all resources/])
   ensure
     build_kubectl.run("delete", "-f", filepath, use_namespace: false, log_failure: false)
   end

test/unit/krane/resource_deployer_test.rb

@@ -66,6 +66,14 @@ def test_deploy_verify_false_no_failure_error
   def test_predeploy_priority_resources_respects_pre_deploy_list
     kind = "MockResource"
     resource = build_mock_resource
+    priority_list = { kind => { group: "not-#{resource.group}" } }
+    resource_deployer(kubectl_times: 0).predeploy_priority_resources([resource], priority_list)
+  end
+
+  def test_predeploy_priority_resources_respects_pre_deploy_list_and_predeployed_true_annotation
+    kind = "MockResource"
+    resource = build_mock_resource
+    resource.expects(:predeployed?).returns(true)
     watcher = mock("ResourceWatcher")
     watcher.expects(:run).returns(true)
     # ResourceDeployer only creates a ResourceWatcher if one or more resources
@@ -76,6 +84,18 @@ def test_predeploy_priority_resources_respects_pre_deploy_list
     resource_deployer.predeploy_priority_resources([resource], priority_list)
   end
 
+  def test_predeploy_priority_resources_respects_pre_deploy_list_and_predeployed_false_annotation
+    kind = "MockResource"
+    resource = build_mock_resource
+    resource.expects(:predeployed?).returns(false)
+    # ResourceDeployer only creates a ResourceWatcher if one or more resources
+    # are deployed. See test_predeploy_priority_resources_respects_empty_pre_deploy_list
+    # for counter example
+    Krane::ResourceWatcher.expects(:new).never
+    priority_list = { kind => { group: "core" } }
+    resource_deployer(kubectl_times: 0).predeploy_priority_resources([resource], priority_list)
+  end
+
   def test_predeploy_priority_resources_respects_empty_pre_deploy_list
     resource = build_mock_resource
     priority_list = []
@@ -98,4 +118,4 @@ def resource_deployer(kubectl_times: 1, prune_allowlist: [])
   def build_mock_resource(final_status: "success", hits_to_complete: 0, name: "web-pod")
     MockResource.new(name, hits_to_complete, final_status)
   end
-end
+end