Class: KubernetesDeploy::KubernetesResource

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes-deploy/kubernetes_resource.rb

Defined Under Namespace

Classes: Event

Constant Summary collapse

GLOBAL = 
false
TIMEOUT = 
5.minutes
LOG_LINE_COUNT = 
250
SERVER_DRY_RUN_DISABLED_ERROR = 
/(unknown flag: --server-dry-run)|(doesn't support dry-run)|(dryRun alpha feature is disabled)/
DISABLE_FETCHING_LOG_INFO = 
'DISABLE_FETCHING_LOG_INFO'
DISABLE_FETCHING_EVENT_INFO = 
'DISABLE_FETCHING_EVENT_INFO'
DISABLED_LOG_INFO_MESSAGE = 
"collection is disabled by the #{DISABLE_FETCHING_LOG_INFO} env var."
DISABLED_EVENT_INFO_MESSAGE = 
"collection is disabled by the #{DISABLE_FETCHING_EVENT_INFO} env var."
DEBUG_RESOURCE_NOT_FOUND_MESSAGE = 
"None found. Please check your usual logging service (e.g. Splunk)."
UNUSUAL_FAILURE_MESSAGE = 
<<~MSG
It is very unusual for this resource type to fail to deploy. Please try the deploy again.
If that new deploy also fails, contact your cluster administrator.
MSG
STANDARD_TIMEOUT_MESSAGE = 
<<~MSG
Kubernetes will continue to attempt to deploy this resource in the cluster, but at this point it is considered unlikely that it will succeed.
If you have reason to believe it will succeed, retry the deploy to continue to monitor the rollout.
MSG
TIMEOUT_OVERRIDE_ANNOTATION_SUFFIX = 
"timeout-override"
TIMEOUT_OVERRIDE_ANNOTATION_DEPRECATED = 
"kubernetes-deploy.shopify.io/#{TIMEOUT_OVERRIDE_ANNOTATION_SUFFIX}"
TIMEOUT_OVERRIDE_ANNOTATION = 
"krane.shopify.io/#{TIMEOUT_OVERRIDE_ANNOTATION_SUFFIX}"
LAST_APPLIED_ANNOTATION = 
"kubectl.kubernetes.io/last-applied-configuration"
SENSITIVE_TEMPLATE_CONTENT = 
false
SERVER_DRY_RUNNABLE = 
false

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(namespace:, context:, definition:, logger:, statsd_tags: []) ⇒ KubernetesResource

Returns a new instance of KubernetesResource.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 111

def initialize(namespace:, context:, definition:, logger:, statsd_tags: [])
  # subclasses must also set these if they define their own initializer
  @name = definition.dig("metadata", "name").to_s
  @optional_statsd_tags = statsd_tags
  @namespace = namespace
  @context = context
  @logger = logger
  @definition = definition
  @statsd_report_done = false
  @disappeared = false
  @validation_errors = []
  @validation_warnings = []
  @instance_data = {}
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



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

def context
  @context
end

#deploy_started_at=(value) ⇒ Object (writeonly)

Sets the attribute deploy_started_at

Parameters:

  • value —

    the value to set the attribute deploy_started_at to.



13
14
15
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 13

def deploy_started_at=(value)
  @deploy_started_at = value
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.



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

def namespace
  @namespace
end

#type ⇒ Object 



222
223
224
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 222

def type
  @type || self.class.kind
end

Class Method Details

.build(namespace:, context:, definition:, logger:, statsd_tags:, crd: nil) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 43

def build(namespace:, context:, definition:, logger:, statsd_tags:, crd: nil)
  validate_definition_essentials(definition)
  opts = { namespace: namespace, context: context, definition: definition, logger: logger,
           statsd_tags: statsd_tags }
  if (klass = class_for_kind(definition["kind"]))
    return klass.new(**opts)
  end
  if crd
    CustomResource.new(crd: crd, **opts)
  else
    inst = new(**opts)
    inst.type = definition["kind"]
    inst
  end
end

.class_for_kind(kind) ⇒ Object 



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

def class_for_kind(kind)
  if KubernetesDeploy.const_defined?(kind)
    KubernetesDeploy.const_get(kind)
  end
rescue NameError
  nil
end

.kind ⇒ Object 



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

def kind
  name.demodulize
end

.timeout ⇒ Object 



67
68
69
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 67

def timeout
  self::TIMEOUT
end

Instance Method Details

#<=>(other) ⇒ Object 



160
161
162
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 160

def <=>(other)
  id <=> other.id
end

#after_sync ⇒ Object 



175
176
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 175

def after_sync
end

#current_generation ⇒ Object 



207
208
209
210
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 207

def current_generation
  return -1 unless exists? # must be different default than observed_generation
  @instance_data.dig("metadata", "generation")
end

#debug_message(cause = nil, info_hash = {}) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 245

def debug_message(cause = nil, info_hash = {})
  helpful_info = []
  if cause == :gave_up
    debug_heading = ColorizedString.new("#{id}: GLOBAL WATCH TIMEOUT (#{info_hash[:timeout]} seconds)").yellow
    helpful_info << "If you expected it to take longer than #{info_hash[:timeout]} seconds for your deploy"\
    " to roll out, increase --max-watch-seconds."
  elsif deploy_failed?
    debug_heading = ColorizedString.new("#{id}: FAILED").red
    helpful_info << failure_message if failure_message.present?
  elsif deploy_timed_out?
    debug_heading = ColorizedString.new("#{id}: TIMED OUT (#{pretty_timeout_type})").yellow
    helpful_info << timeout_message if timeout_message.present?
  else
    # Arriving in debug_message when we neither failed nor timed out is very unexpected. Dump all available info.
    debug_heading = ColorizedString.new("#{id}: MONITORING ERROR").red
    helpful_info << failure_message if failure_message.present?
    helpful_info << timeout_message if timeout_message.present? && timeout_message != STANDARD_TIMEOUT_MESSAGE
  end

  final_status = "  - Final status: #{status}"
  final_status = "\n#{final_status}" if helpful_info.present? && !helpful_info.last.end_with?("\n")
  helpful_info.prepend(debug_heading)
  helpful_info << final_status

  if @debug_events.present?
    helpful_info << "  - Events (common success events excluded):"
    @debug_events.each do |identifier, event_hashes|
      event_hashes.each { |event| helpful_info << "      [#{identifier}]\t#{event}" }
    end
  elsif ENV[DISABLE_FETCHING_EVENT_INFO]
    helpful_info << "  - Events: #{DISABLED_EVENT_INFO_MESSAGE}"
  else
    helpful_info << "  - Events: #{DEBUG_RESOURCE_NOT_FOUND_MESSAGE}"
  end

  if print_debug_logs?
    if ENV[DISABLE_FETCHING_LOG_INFO]
      helpful_info << "  - Logs: #{DISABLED_LOG_INFO_MESSAGE}"
    elsif @debug_logs.blank?
      helpful_info << "  - Logs: #{DEBUG_RESOURCE_NOT_FOUND_MESSAGE}"
    else
      container_logs = @debug_logs.container_logs.sort_by { |c| c.lines.length }
      container_logs.each do |logs|
        if logs.empty?
          helpful_info << "  - Logs from container '#{logs.container_name}': #{DEBUG_RESOURCE_NOT_FOUND_MESSAGE}"
          next
        end

        if logs.lines.length == ContainerLogs::DEFAULT_LINE_LIMIT
          truncated = " (last #{ContainerLogs::DEFAULT_LINE_LIMIT} lines shown)"
        end
        helpful_info << "  - Logs from container '#{logs.container_name}'#{truncated}:"
        logs.lines.each do |line|
          helpful_info << "      #{line}"
        end
      end
    end
  end

  helpful_info.join("\n")
end

#deploy_failed? ⇒ Boolean

Returns:

  • (Boolean) 


186
187
188
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 186

def deploy_failed?
  false
end

#deploy_method ⇒ Object

Expected values: :apply, :replace, :replace_force



236
237
238
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 236

def deploy_method
  :apply
end

#deploy_started? ⇒ Boolean

Returns:

  • (Boolean) 


190
191
192
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 190

def deploy_started?
  @deploy_started_at.present?
end

#deploy_succeeded? ⇒ Boolean

Returns:

  • (Boolean) 


194
195
196
197
198
199
200
201
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 194

def deploy_succeeded?
  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
  true
end

#deploy_timed_out? ⇒ Boolean

Returns:

  • (Boolean) 


230
231
232
233
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 230

def deploy_timed_out?
  return false unless deploy_started?
  !deploy_succeeded? && !deploy_failed? && (Time.now.utc - @deploy_started_at > timeout)
end

#disappeared? ⇒ Boolean

Returns:

  • (Boolean) 


182
183
184
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 182

def disappeared?
  @disappeared
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


203
204
205
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 203

def exists?
  @instance_data.present?
end

#failure_message ⇒ Object 



330
331
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 330

def failure_message
end

#fetch_events(kubectl) ⇒ Object

Returns a hash in the following format: 

"pod/web-1" => [
  "Pulling: pulling image "hello-world:latest" (1 events)",
  "Pulled: Successfully pulled image "hello-world:latest" (1 events)"
]




314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 314

def fetch_events(kubectl)
  return {} unless exists?
  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] = [] }
  Event.extract_all_from_go_template_blob(out).each_with_object(event_collector) do |candidate, events|
    events[id] << candidate.to_s if candidate.seen_since?(@deploy_started_at - 5.seconds)
  end
end

#file_path ⇒ Object 



164
165
166
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 164

def file_path
  file.path
end

#global? ⇒ Boolean

Returns:

  • (Boolean) 


413
414
415
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 413

def global?
  self.class::GLOBAL
end

#has_warnings? ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 144

def has_warnings?
  @validation_warnings.present?
end

#id ⇒ Object 



156
157
158
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 156

def id
  "#{type}/#{name}"
end

#kubectl_resource_type ⇒ Object 



226
227
228
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 226

def kubectl_resource_type
  type
end

#observed_generation ⇒ Object 



212
213
214
215
216
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 212

def observed_generation
  return -2 unless exists?
  # populating this is a best practice, but not all controllers actually do it
  @instance_data.dig('status', 'observedGeneration')
end

#pretty_status ⇒ Object 



333
334
335
336
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 333

def pretty_status
  padding = " " * [50 - id.length, 1].max
  "#{id}#{padding}#{status}"
end

#pretty_timeout_type ⇒ Object 



107
108
109
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 107

def pretty_timeout_type
  "timeout: #{timeout}s"
end

#report_status_to_statsd(watch_time) ⇒ Object 



338
339
340
341
342
343
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 338

def report_status_to_statsd(watch_time)
  unless @statsd_report_done
    StatsD.distribution('resource.duration', watch_time, tags: statsd_tags)
    @statsd_report_done = true
  end
end

#sensitive_template_content? ⇒ Boolean

Returns:

  • (Boolean) 


345
346
347
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 345

def sensitive_template_content?
  self.class::SENSITIVE_TEMPLATE_CONTENT
end

#server_dry_runnable? ⇒ Boolean

Returns:

  • (Boolean) 


349
350
351
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 349

def server_dry_runnable?
  self.class::SERVER_DRY_RUNNABLE
end

#status ⇒ Object 



218
219
220
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 218

def status
  exists? ? "Exists" : "Not Found"
end

#sync(cache) ⇒ Object 



168
169
170
171
172
173
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 168

def sync(cache)
  @instance_data = cache.get_instance(kubectl_resource_type, name, raise_if_not_found: true)
rescue KubernetesDeploy::Kubectl::ResourceNotFoundError
  @disappeared = true if deploy_started?
  @instance_data = {}
end

#sync_debug_info(kubectl) ⇒ Object 



240
241
242
243
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 240

def sync_debug_info(kubectl)
  @debug_events = fetch_events(kubectl) unless ENV[DISABLE_FETCHING_EVENT_INFO]
  @debug_logs = fetch_debug_logs if print_debug_logs? && !ENV[DISABLE_FETCHING_LOG_INFO]
end

#terminating? ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 178

def terminating?
  @instance_data.dig('metadata', 'deletionTimestamp').present?
end

#timeout ⇒ Object 



94
95
96
97
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 94

def timeout
  return timeout_override if timeout_override.present?
  self.class.timeout
end

#timeout_message ⇒ Object 



326
327
328
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 326

def timeout_message
  STANDARD_TIMEOUT_MESSAGE
end

#timeout_override ⇒ Object 



99
100
101
102
103
104
105
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 99

def timeout_override
  return @timeout_override if defined?(@timeout_override)

  @timeout_override = DurationParser.new(krane_annotation_value(TIMEOUT_OVERRIDE_ANNOTATION_SUFFIX)).parse!.to_i
rescue DurationParser::ParsingError
  @timeout_override = nil
end

#to_kubeclient_resource ⇒ Object 



126
127
128
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 126

def to_kubeclient_resource
  Kubeclient::Resource.new(@definition)
end

#validate_definition(kubectl, selector: nil) ⇒ Object 



130
131
132
133
134
135
136
137
138
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 130

def validate_definition(kubectl, selector: nil)
  @validation_errors = []
  @validation_warnings = []
  validate_selector(selector) if selector
  validate_timeout_annotation
  validate_annotation_version
  validate_spec_with_kubectl(kubectl)
  @validation_errors.present?
end

#validation_error_msg ⇒ Object 



148
149
150
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 148

def validation_error_msg
  @validation_errors.join("\n")
end

#validation_failed? ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 152

def validation_failed?
  @validation_errors.present?
end

#validation_warning_msg ⇒ Object 



140
141
142
 
# File 'lib/kubernetes-deploy/kubernetes_resource.rb', line 140

def validation_warning_msg
  @validation_warnings.join("\n")
end