Class: Krane::KubernetesResource

Inherits:
Object
  • Object
show all
Defined in:
lib/krane/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)|(does[\s\']n[o|']t support dry[-\s]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
SYNC_DEPENDENCIES = 
[]

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.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/krane/kubernetes_resource.rb', line 115

def initialize(namespace:, context:, definition:, logger:, statsd_tags: [])
  # subclasses must also set these if they define their own initializer
  @name = (definition.dig("metadata", "name") || definition.dig("metadata", "generateName")).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 = {}
  @server_dry_run_validated = false
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



12
13
14
 
# File 'lib/krane/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/krane/kubernetes_resource.rb', line 13

def deploy_started_at=(value)
  @deploy_started_at = value
end

#global=(value) ⇒ Object (writeonly)

Sets the attribute global

Parameters:

  • value —

    the value to set the attribute global to.



13
14
15
 
# File 'lib/krane/kubernetes_resource.rb', line 13

def global=(value)
  @global = value
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



12
13
14
 
# File 'lib/krane/kubernetes_resource.rb', line 12

def name
  @name
end

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.



12
13
14
 
# File 'lib/krane/kubernetes_resource.rb', line 12

def namespace
  @namespace
end

#type ⇒ Object 



227
228
229
 
# File 'lib/krane/kubernetes_resource.rb', line 227

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

Class Method Details

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/krane/kubernetes_resource.rb', line 44

def build(namespace: nil, context:, definition:, logger:, statsd_tags:, crd: nil, global_names: [])
  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
    type = definition["kind"]
    inst = new(**opts)
    inst.type = type
    inst.global = global_names.map(&:downcase).include?(type.downcase)
    inst
  end
end

.class_for_kind(kind) ⇒ Object 



62
63
64
65
66
67
68
 
# File 'lib/krane/kubernetes_resource.rb', line 62

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

.kind ⇒ Object 



74
75
76
 
# File 'lib/krane/kubernetes_resource.rb', line 74

def kind
  name.demodulize
end

.timeout ⇒ Object 



70
71
72
 
# File 'lib/krane/kubernetes_resource.rb', line 70

def timeout
  self::TIMEOUT
end

Instance Method Details

#<=>(other) ⇒ Object 



165
166
167
 
# File 'lib/krane/kubernetes_resource.rb', line 165

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

#after_sync ⇒ Object 



180
181
 
# File 'lib/krane/kubernetes_resource.rb', line 180

def after_sync
end

#current_generation ⇒ Object 



212
213
214
215
 
# File 'lib/krane/kubernetes_resource.rb', line 212

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 



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
306
307
308
309
310
311
312
313
314
 
# File 'lib/krane/kubernetes_resource.rb', line 254

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 --global-timeout."
  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) 


191
192
193
 
# File 'lib/krane/kubernetes_resource.rb', line 191

def deploy_failed?
  false
end

#deploy_method ⇒ Object

Expected values: :apply, :create, :replace, :replace_force



241
242
243
244
245
246
247
 
# File 'lib/krane/kubernetes_resource.rb', line 241

def deploy_method
  if @definition.dig("metadata", "name").blank? && uses_generate_name?
    :create
  else
    :apply
  end
end

#deploy_started? ⇒ Boolean

Returns:

  • (Boolean) 


195
196
197
 
# File 'lib/krane/kubernetes_resource.rb', line 195

def deploy_started?
  @deploy_started_at.present?
end

#deploy_succeeded? ⇒ Boolean

Returns:

  • (Boolean) 


199
200
201
202
203
204
205
206
 
# File 'lib/krane/kubernetes_resource.rb', line 199

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) 


235
236
237
238
 
# File 'lib/krane/kubernetes_resource.rb', line 235

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) 


187
188
189
 
# File 'lib/krane/kubernetes_resource.rb', line 187

def disappeared?
  @disappeared
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


208
209
210
 
# File 'lib/krane/kubernetes_resource.rb', line 208

def exists?
  @instance_data.present?
end

#failure_message ⇒ Object 



339
340
 
# File 'lib/krane/kubernetes_resource.rb', line 339

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)"
]




323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/krane/kubernetes_resource.rb', line 323

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, use_namespace: !global?)
  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 



169
170
171
 
# File 'lib/krane/kubernetes_resource.rb', line 169

def file_path
  file.path
end

#global? ⇒ Boolean

Returns:

  • (Boolean) 


491
492
493
 
# File 'lib/krane/kubernetes_resource.rb', line 491

def global?
  @global || self.class::GLOBAL
end

#has_warnings? ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/krane/kubernetes_resource.rb', line 149

def has_warnings?
  @validation_warnings.present?
end

#id ⇒ Object 



161
162
163
 
# File 'lib/krane/kubernetes_resource.rb', line 161

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

#kubectl_resource_type ⇒ Object 



231
232
233
 
# File 'lib/krane/kubernetes_resource.rb', line 231

def kubectl_resource_type
  type
end

#observed_generation ⇒ Object 



217
218
219
220
221
 
# File 'lib/krane/kubernetes_resource.rb', line 217

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 



342
343
344
345
 
# File 'lib/krane/kubernetes_resource.rb', line 342

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

#pretty_timeout_type ⇒ Object 



111
112
113
 
# File 'lib/krane/kubernetes_resource.rb', line 111

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

#report_status_to_statsd(watch_time) ⇒ Object 



347
348
349
350
351
352
 
# File 'lib/krane/kubernetes_resource.rb', line 347

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

#sensitive_template_content? ⇒ Boolean

Returns:

  • (Boolean) 


354
355
356
 
# File 'lib/krane/kubernetes_resource.rb', line 354

def sensitive_template_content?
  self.class::SENSITIVE_TEMPLATE_CONTENT
end

#server_dry_run_validated? ⇒ Boolean

Returns:

  • (Boolean) 


368
369
370
 
# File 'lib/krane/kubernetes_resource.rb', line 368

def server_dry_run_validated?
  @server_dry_run_validated
end

#server_dry_runnable_resource? ⇒ Boolean

Returns:

  • (Boolean) 


358
359
360
361
362
 
# File 'lib/krane/kubernetes_resource.rb', line 358

def server_dry_runnable_resource?
  # generateName and server-side dry run are incompatible because the former only works with `create`
  # and the latter only works with `apply`
  self.class::SERVER_DRY_RUNNABLE && !uses_generate_name?
end

#status ⇒ Object 



223
224
225
 
# File 'lib/krane/kubernetes_resource.rb', line 223

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

#sync(cache) ⇒ Object 



173
174
175
176
177
178
 
# File 'lib/krane/kubernetes_resource.rb', line 173

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

#sync_debug_info(kubectl) ⇒ Object 



249
250
251
252
 
# File 'lib/krane/kubernetes_resource.rb', line 249

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) 


183
184
185
 
# File 'lib/krane/kubernetes_resource.rb', line 183

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

#timeout ⇒ Object 



98
99
100
101
 
# File 'lib/krane/kubernetes_resource.rb', line 98

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

#timeout_message ⇒ Object 



335
336
337
 
# File 'lib/krane/kubernetes_resource.rb', line 335

def timeout_message
  STANDARD_TIMEOUT_MESSAGE
end

#timeout_override ⇒ Object 



103
104
105
106
107
108
109
 
# File 'lib/krane/kubernetes_resource.rb', line 103

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 



131
132
133
 
# File 'lib/krane/kubernetes_resource.rb', line 131

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

#use_generated_name(instance_data) ⇒ Object

If a resource uses generateName, we don’t know the full name of the resource until it’s deployed to the cluster. In this case, we need to update our local definition with the realized name in order to accurately track the resource during deploy



375
376
377
378
379
380
 
# File 'lib/krane/kubernetes_resource.rb', line 375

def use_generated_name(instance_data)
  @name = instance_data.dig('metadata', 'name')
  @definition['metadata']['name'] = @name
  @definition['metadata'].delete('generateName')
  @file = create_definition_tempfile
end

#uses_generate_name? ⇒ Boolean

Returns:

  • (Boolean) 


364
365
366
 
# File 'lib/krane/kubernetes_resource.rb', line 364

def uses_generate_name?
  @definition.dig('metadata', 'generateName').present?
end

#validate_definition(kubectl, selector: nil) ⇒ Object 



135
136
137
138
139
140
141
142
143
 
# File 'lib/krane/kubernetes_resource.rb', line 135

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 



153
154
155
 
# File 'lib/krane/kubernetes_resource.rb', line 153

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

#validation_failed? ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
 
# File 'lib/krane/kubernetes_resource.rb', line 157

def validation_failed?
  @validation_errors.present?
end

#validation_warning_msg ⇒ Object 



145
146
147
 
# File 'lib/krane/kubernetes_resource.rb', line 145

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