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'
SYNC_DEPENDENCIES = 
%w(Pod ReplicaSet)

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::LOG_LINE_COUNT, 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

build, #debug_message, #deploy_method, #deploy_started?, #exists?, #file_path, #id, #initialize, kind, #pretty_status, #report_status_to_statsd, #sync_debug_info, #timeout, timeout, #timeout_override, #validation_error_msg, #validation_failed?

Constructor Details

This class inherits a constructor from KubernetesDeploy::KubernetesResource

Instance Method Details

#deploy_failed? ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 53

def deploy_failed?
  @latest_rs&.deploy_failed?
end

#deploy_succeeded? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

  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) 


76
77
78
79
80
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 76

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

#failure_message ⇒ Object 



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

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

#fetch_events(kubectl) ⇒ Object 



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

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

#fetch_logs(kubectl) ⇒ Object 



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

def fetch_logs(kubectl)
  return {} unless @latest_rs.present?
  @latest_rs.fetch_logs(kubectl)
end

#pretty_timeout_type ⇒ Object 



72
73
74
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 72

def pretty_timeout_type
  progress_deadline.present? ? "progress deadline: #{progress_deadline}s" : super
end

#status ⇒ Object 



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

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

#sync(mediator) ⇒ Object 



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

def sync(mediator)
  super
  @latest_rs = exists? ? find_latest_rs(mediator) : nil
  @server_version ||= mediator.kubectl.server_version
end

#timeout_message ⇒ Object 



62
63
64
65
66
67
68
69
70
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 62

def timeout_message
  reason_msg = if 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 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/kubernetes-deploy/kubernetes_resource/deployment.rb', line 82

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