kubernetes-deploy 0.30.0 → 0.31.0

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/cloudsql.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class Cloudsql < KubernetesResource
     TIMEOUT = 10.minutes
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/config_map.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class ConfigMap < KubernetesResource
     TIMEOUT = 30.seconds
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/cron_job.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class CronJob < KubernetesResource
     TIMEOUT = 30.seconds
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/custom_resource.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'jsonpath'
 
-module KubernetesDeploy
+module Krane
   class CustomResource < KubernetesResource
     TIMEOUT_MESSAGE_DIFFERENT_GENERATIONS = <<~MSG
       This resource's status could not be used to determine rollout success because it is not up-to-date
@@ -68,7 +68,7 @@ module KubernetesDeploy
       @crd.validate_rollout_conditions
     rescue RolloutConditionsError => e
       @validation_errors << "The CRD that specifies this resource is using invalid rollout conditions. " \
-      "Kubernetes-deploy will not be able to continue until those rollout conditions are fixed.\n" \
+      "Krane will not be able to continue until those rollout conditions are fixed.\n" \
       "Rollout conditions can be found on the CRD that defines this resource (#{@crd.name}), " \
       "under the annotation #{CustomResourceDefinition::ROLLOUT_CONDITIONS_ANNOTATION}.\n" \
       "Validation failed with: #{e}"

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/custom_resource_definition.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class CustomResourceDefinition < KubernetesResource
     TIMEOUT = 2.minutes
     ROLLOUT_CONDITIONS_ANNOTATION_SUFFIX = "instance-rollout-conditions"
@@ -46,10 +46,6 @@ module KubernetesDeploy
       @definition.dig("spec", "names", "kind")
     end
 
-    def name
-      @definition.dig("metadata", "name")
-    end
-
     def prunable?
       prunable = krane_annotation_value("prunable")
       prunable == "true"

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/daemon_set.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'kubernetes-deploy/kubernetes_resource/pod_set_base'
-module KubernetesDeploy
+require 'krane/kubernetes_resource/pod_set_base'
+module Krane
   class DaemonSet < PodSetBase
     TIMEOUT = 5.minutes
     attr_reader :pods
@@ -58,8 +58,11 @@ module KubernetesDeploy
       return true if rollout_data["desiredNumberScheduled"].to_i == rollout_data["numberReady"].to_i # all pods ready
       relevant_node_names = @nodes.map(&:name)
       considered_pods = @pods.select { |p| relevant_node_names.include?(p.node_name) }
-      @logger.debug("Considered #{considered_pods.size} pods out of #{@pods.size} for #{@nodes.size} nodes")
-      considered_pods.present? && considered_pods.all?(&:deploy_succeeded?)
+      @logger.debug("DaemonSet is reporting #{rollout_data['numberReady']} pods ready." \
+        " Considered #{considered_pods.size} pods out of #{@pods.size} for #{@nodes.size} nodes.")
+      considered_pods.present? &&
+        considered_pods.all?(&:deploy_succeeded?) &&
+        rollout_data["numberReady"].to_i >= considered_pods.length
     end
 
     def find_nodes(cache)

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/deployment.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require 'kubernetes-deploy/kubernetes_resource/replica_set'
+require 'krane/kubernetes_resource/replica_set'
 
-module KubernetesDeploy
+module Krane
   class Deployment < KubernetesResource
     TIMEOUT = 7.minutes
     REQUIRED_ROLLOUT_ANNOTATION_SUFFIX = "required-rollout"

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/horizontal_pod_autoscaler.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class HorizontalPodAutoscaler < KubernetesResource
     TIMEOUT = 3.minutes
     RECOVERABLE_CONDITION_PREFIX = "FailedGet"

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/ingress.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class Ingress < KubernetesResource
     TIMEOUT = 30.seconds
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/job.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class Job < KubernetesResource
     TIMEOUT = 10.minutes
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/network_policy.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class NetworkPolicy < KubernetesResource
     TIMEOUT = 30.seconds
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/persistent_volume_claim.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class PersistentVolumeClaim < KubernetesResource
     TIMEOUT = 5.minutes
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/pod.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class Pod < KubernetesResource
     TIMEOUT = 10.minutes
 
@@ -141,7 +141,7 @@ module KubernetesDeploy
     end
 
     def logs
-      @logs ||= KubernetesDeploy::RemoteLogs.new(
+      @logs ||= Krane::RemoteLogs.new(
         logger: @logger,
         parent_id: id,
         container_names: @containers.map(&:name),

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/pod_disruption_budget.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class PodDisruptionBudget < KubernetesResource
     TIMEOUT = 10.seconds
 
@@ -13,7 +13,7 @@ module KubernetesDeploy
 
     def deploy_method
       # Required until https://github.com/kubernetes/kubernetes/issues/45398 changes
-      :replace_force
+      uses_generate_name? ? :create : :replace_force
     end
 
     def timeout_message

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/pod_set_base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require 'kubernetes-deploy/kubernetes_resource/pod'
+require 'krane/kubernetes_resource/pod'
 
-module KubernetesDeploy
+module Krane
   class PodSetBase < KubernetesResource
     def failure_message
       pods.map(&:failure_message).compact.uniq.join("\n")
@@ -19,7 +19,7 @@ module KubernetesDeploy
     end
 
     def fetch_debug_logs
-      logs = KubernetesDeploy::RemoteLogs.new(
+      logs = Krane::RemoteLogs.new(
         logger: @logger,
         parent_id: id,
         container_names: container_names,

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/pod_template.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class PodTemplate < KubernetesResource
     def status
       exists? ? "Available" : "Not Found"

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/replica_set.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require 'kubernetes-deploy/kubernetes_resource/pod_set_base'
+require 'krane/kubernetes_resource/pod_set_base'
 
-module KubernetesDeploy
+module Krane
   class ReplicaSet < PodSetBase
     TIMEOUT = 5.minutes
     attr_reader :pods

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/resource_quota.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class ResourceQuota < KubernetesResource
     TIMEOUT = 30.seconds
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/role.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class Role < KubernetesResource
     TIMEOUT = 30.seconds
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/role_binding.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class RoleBinding < KubernetesResource
     TIMEOUT = 30.seconds
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/secret.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class Secret < KubernetesResource
     TIMEOUT = 30.seconds
     SENSITIVE_TEMPLATE_CONTENT = true

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/service.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require 'kubernetes-deploy/kubernetes_resource/pod'
+require 'krane/kubernetes_resource/pod'
 
-module KubernetesDeploy
+module Krane
   class Service < KubernetesResource
     TIMEOUT = 7.minutes
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/service_account.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-module KubernetesDeploy
+module Krane
   class ServiceAccount < KubernetesResource
     TIMEOUT = 30.seconds
 

data/lib/{kubernetes-deploy → krane}/kubernetes_resource/stateful_set.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'kubernetes-deploy/kubernetes_resource/pod_set_base'
-module KubernetesDeploy
+require 'krane/kubernetes_resource/pod_set_base'
+module Krane
   class StatefulSet < PodSetBase
     TIMEOUT = 10.minutes
     ONDELETE = 'OnDelete'

data/lib/{kubernetes-deploy → krane}/label_selector.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module KubernetesDeploy
+module Krane
   class LabelSelector
     def self.parse(string)
       selector = {}

data/lib/{kubernetes-deploy → krane}/options_helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module KubernetesDeploy
+module Krane
   module OptionsHelper
     class OptionsError < StandardError; end
 
@@ -19,7 +19,7 @@ module KubernetesDeploy
         end
 
         if template_paths.include?("-")
-          Dir.mktmpdir("kubernetes-deploy") do |dir|
+          Dir.mktmpdir("krane") do |dir|
             template_dir_from_stdin(temp_dir: dir)
             validated_paths << dir
             yield validated_paths

data/lib/{kubernetes-deploy → krane}/remote_logs.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require 'kubernetes-deploy/container_logs'
+require 'krane/container_logs'
 
-module KubernetesDeploy
+module Krane
   class RemoteLogs
     attr_reader :container_logs
 

data/lib/krane/render_task.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+require 'tempfile'
+
+require 'krane/common'
+require 'krane/renderer'
+require 'krane/template_sets'
+
+module Krane
+  # Render templates
+  class RenderTask
+    # Initializes the render task
+    #
+    # @param logger [Object] Logger object (defaults to an instance of Krane::FormattedLogger)
+    # @param current_sha [String] The SHA of the commit
+    # @param template_dir [String] Path to a directory with templates to render (deprecated)
+    # @param template_paths [Array<String>] An array of template paths to render
+    # @param bindings [Hash] Bindings parsed by Krane::BindingsParser
+    def initialize(logger: nil, current_sha:, template_dir: nil, template_paths: [], bindings:)
+      @logger = logger || Krane::FormattedLogger.build
+      @template_dir = template_dir
+      @template_paths = template_paths.map { |path| File.expand_path(path) }
+      @bindings = bindings
+      @current_sha = current_sha
+    end
+
+    # Runs the task, returning a boolean representing success or failure
+    #
+    # @return [Boolean]
+    def run(*args)
+      run!(*args)
+      true
+    rescue Krane::FatalDeploymentError
+      false
+    end
+
+    # Runs the task, raising exceptions in case of issues
+    #
+    # @param stream [IO] Place to stream the output to
+    # @param only_filenames [Array<String>] List of filenames to render
+    #
+    # @return [nil]
+    def run!(stream, only_filenames = [])
+      @logger.reset
+      @logger.phase_heading("Initializing render task")
+
+      ts = TemplateSets.from_dirs_and_files(paths: template_sets_paths(only_filenames), logger: @logger)
+
+      validate_configuration(ts, only_filenames)
+      count = render_templates(stream, ts)
+
+      @logger.summary.add_action("Successfully rendered #{count} template(s)")
+      @logger.print_summary(:success)
+    rescue Krane::FatalDeploymentError
+      @logger.print_summary(:failure)
+      raise
+    end
+
+    private
+
+    def template_sets_paths(only_filenames)
+      if @template_paths.present?
+        # Validation will catch @template_paths & @template_dir being present
+        @template_paths
+      elsif only_filenames.blank?
+        [File.expand_path(@template_dir || '')]
+      else
+        absolute_template_dir = File.expand_path(@template_dir || '')
+        only_filenames.map do |name|
+          File.join(absolute_template_dir, name)
+        end
+      end
+    end
+
+    def render_templates(stream, template_sets)
+      @logger.phase_heading("Rendering template(s)")
+      count = 0
+      template_sets.with_resource_definitions_and_filename(render_erb: true,
+          current_sha: @current_sha, bindings: @bindings, raw: true) do |rendered_content, filename|
+        write_to_stream(rendered_content, filename, stream)
+        count += 1
+      end
+
+      count
+    rescue Krane::InvalidTemplateError => exception
+      log_invalid_template(exception)
+      raise
+    end
+
+    def write_to_stream(rendered_content, filename, stream)
+      file_basename = File.basename(filename)
+      @logger.info("Rendering #{file_basename}...")
+      implicit = []
+      YAML.parse_stream(rendered_content, "<rendered> #{filename}") { |d| implicit << d.implicit }
+      if rendered_content.present?
+        stream.puts "---\n" if implicit.first
+        stream.puts rendered_content
+        @logger.info("Rendered #{file_basename}")
+      else
+        @logger.warn("Rendered #{file_basename} successfully, but the result was blank")
+      end
+    rescue Psych::SyntaxError => exception
+      raise InvalidTemplateError.new("Template is not valid YAML. #{exception.message}", filename: filename)
+    end
+
+    def validate_configuration(template_sets, filenames)
+      @logger.info("Validating configuration")
+      errors = []
+      if @template_dir.present? && @template_paths.present?
+        errors << "template_dir and template_paths can not be combined"
+      elsif @template_dir.blank? && @template_paths.blank?
+        errors << "template_dir or template_paths must be set"
+      end
+
+      if filenames.present?
+        if @template_dir.nil?
+          errors << "template_dir must be set to use filenames"
+        else
+          absolute_template_dir = File.expand_path(@template_dir)
+          filenames.each do |filename|
+            absolute_file = File.expand_path(File.join(@template_dir, filename))
+            unless absolute_file.start_with?(absolute_template_dir)
+              errors << "Filename \"#{absolute_file}\" is outside the template directory," \
+              " which was resolved as #{absolute_template_dir}"
+            end
+          end
+        end
+      end
+
+      errors += template_sets.validate
+
+      unless errors.empty?
+        @logger.summary.add_action("Configuration invalid")
+        @logger.summary.add_paragraph(errors.map { |err| "- #{err}" }.join("\n"))
+        raise Krane::TaskConfigurationError, "Configuration invalid: #{errors.join(', ')}"
+      end
+    end
+
+    def log_invalid_template(exception)
+      @logger.error("Failed to render #{exception.filename}")
+
+      debug_msg = ColorizedString.new("Invalid template: #{exception.filename}\n").red
+      debug_msg += "> Error message:\n#{FormattedLogger.indent_four(exception.to_s)}"
+      if exception.content
+        debug_msg += "\n> Template content:\n#{FormattedLogger.indent_four(exception.content)}"
+      end
+      @logger.summary.add_paragraph(debug_msg)
+    end
+  end
+end