Class: KubernetesDeploy::Deployment

Inherits:
KubernetesResource show all
Defined in:
lib/kubernetes-deploy/kubernetes_resource/deployment.rb

Constant Summary collapse

TIMEOUT = 
7.minutes
REQUIRED_ROLLOUT_ANNOTATION = 
'kubernetes-deploy.shopify.io/required-rollout'
REQUIRED_ROLLOUT_TYPES = 
%w(maxUnavailable full none).freeze
DEFAULT_REQUIRED_ROLLOUT = 
'full'

Constants inherited from KubernetesResource

KubernetesResource::DEBUG_RESOURCE_NOT_FOUND_MESSAGE, KubernetesResource::DISABLED_EVENT_INFO_MESSAGE, KubernetesResource::DISABLED_LOG_INFO_MESSAGE, KubernetesResource::DISABLE_FETCHING_EVENT_INFO, KubernetesResource::DISABLE_FETCHING_LOG_INFO, KubernetesResource::GLOBAL, KubernetesResource::LAST_APPLIED_ANNOTATION, KubernetesResource::LOG_LINE_COUNT, KubernetesResource::SENSITIVE_TEMPLATE_CONTENT, KubernetesResource::STANDARD_TIMEOUT_MESSAGE, KubernetesResource::TIMEOUT_OVERRIDE_ANNOTATION, KubernetesResource::UNUSUAL_FAILURE_MESSAGE

Instance Attribute Summary

Attributes inherited from KubernetesResource

#context, #deploy_started_at, #name, #namespace, #type

Instance Method Summary collapse

Methods inherited from KubernetesResource

#<=>, #after_sync, build, class_for_kind, #debug_message, #deploy_method, #deploy_started?, #disappeared?, #exists?, #file_path, #global?, #id, #initialize, kind, #kubectl_resource_type, #pretty_status, #report_status_to_statsd, #sensitive_template_content?, #sync_debug_info, #terminating?, timeout, #timeout, #timeout_override, #to_kubeclient_resource, #validation_error_msg, #validation_failed?

Constructor Details

This class inherits a constructor from KubernetesDeploy::KubernetesResource

Instance Method Details

#deploy_failed? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
58
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 55

def deploy_failed?
  @latest_rs&.deploy_failed? &&
  observed_generation == current_generation
end

#deploy_succeeded? ⇒ Boolean

Returns:

  • (Boolean) 


33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 33

def deploy_succeeded?
  return false unless exists? && @latest_rs.present?
  return false unless observed_generation == current_generation

  if required_rollout == 'full'
    @latest_rs.deploy_succeeded? &&
    @latest_rs.desired_replicas == desired_replicas && # latest RS fully scaled up
    rollout_data["updatedReplicas"].to_i == desired_replicas &&
    rollout_data["updatedReplicas"].to_i == rollout_data["availableReplicas"].to_i
  elsif required_rollout == 'none'
    true
  elsif required_rollout == 'maxUnavailable' || percent?(required_rollout)
    minimum_needed = min_available_replicas

    @latest_rs.desired_replicas >= minimum_needed &&
    @latest_rs.ready_replicas >= minimum_needed &&
    @latest_rs.available_replicas >= minimum_needed
  else
    raise FatalDeploymentError, rollout_annotation_err_msg
  end
end

#deploy_timed_out? ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
90
91
92
93
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 87

def deploy_timed_out?
  return false if deploy_failed?
  return super if timeout_override

  # Do not use the hard timeout if progress deadline is set
  progress_condition.present? ? deploy_failing_to_progress? : super
end

#failure_message ⇒ Object 



60
61
62
63
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 60

def failure_message
  return unless @latest_rs.present?
  "Latest ReplicaSet: #{@latest_rs.name}\n\n#{@latest_rs.failure_message}"
end

#fetch_debug_logs ⇒ Object 



29
30
31
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 29

def fetch_debug_logs
  @latest_rs.fetch_debug_logs
end

#fetch_events(kubectl) ⇒ Object 



19
20
21
22
23
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 19

def fetch_events(kubectl)
  own_events = super
  return own_events unless @latest_rs.present?
  own_events.merge(@latest_rs.fetch_events(kubectl))
end

#pretty_timeout_type ⇒ Object 



77
78
79
80
81
82
83
84
85
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 77

def pretty_timeout_type
  if timeout_override
    "timeout override: #{timeout_override}s"
  elsif progress_deadline.present?
    "progress deadline: #{progress_deadline}s"
  else
    super
  end
end

#print_debug_logs? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 25

def print_debug_logs?
  @latest_rs.present?
end

#status ⇒ Object 



14
15
16
17
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 14

def status
  return super unless exists?
  rollout_data.map { |state_replicas, num| "#{num} #{state_replicas.chop.pluralize(num)}" }.join(", ")
end

#sync(cache) ⇒ Object 



9
10
11
12
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 9

def sync(cache)
  super
  @latest_rs = exists? ? find_latest_rs(cache) : nil
end

#timeout_message ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 65

def timeout_message
  reason_msg = if timeout_override
    STANDARD_TIMEOUT_MESSAGE
  elsif progress_condition.present?
    "Timeout reason: #{progress_condition['reason']}"
  else
    "Timeout reason: hard deadline for #{type}"
  end
  return reason_msg unless @latest_rs.present?
  "#{reason_msg}\nLatest ReplicaSet: #{@latest_rs.name}\n\n#{@latest_rs.timeout_message}"
end

#validate_definition ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 95

def validate_definition(*)
  super

  unless REQUIRED_ROLLOUT_TYPES.include?(required_rollout) || percent?(required_rollout)
    @validation_errors << rollout_annotation_err_msg
  end

  strategy = @definition.dig('spec', 'strategy', 'type').to_s
  if required_rollout.downcase == 'maxunavailable' && strategy.present? && strategy.downcase != 'rollingupdate'
    @validation_errors << "'#{REQUIRED_ROLLOUT_ANNOTATION}: #{required_rollout}' is incompatible "\
    "with strategy '#{strategy}'"
  end

  @validation_errors.empty?
end