Class: Krane::StatefulSet

Inherits:
PodSetBase show all
Defined in:
lib/krane/kubernetes_resource/stateful_set.rb

Constant Summary collapse

TIMEOUT = 
10.minutes
ONDELETE = 
'OnDelete'
SYNC_DEPENDENCIES = 
%w(Pod)

Constants inherited from KubernetesResource

KubernetesResource::ALLOWED_DEPLOY_METHOD_OVERRIDES, KubernetesResource::DEBUG_RESOURCE_NOT_FOUND_MESSAGE, KubernetesResource::DEPLOY_METHOD_OVERRIDE_ANNOTATION, 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::SERVER_DRY_RUNNABLE, KubernetesResource::SERVER_DRY_RUN_DISABLED_ERROR, KubernetesResource::STANDARD_TIMEOUT_MESSAGE, KubernetesResource::TIMEOUT_OVERRIDE_ANNOTATION, KubernetesResource::UNUSUAL_FAILURE_MESSAGE

Instance Attribute Summary collapse

Attributes inherited from KubernetesResource

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

Instance Method Summary collapse

Methods inherited from PodSetBase

#failure_message, #fetch_debug_logs, #fetch_events, #print_debug_logs?, #timeout_message

Methods inherited from KubernetesResource

#<=>, #after_sync, build, class_for_kind, #current_generation, #debug_message, #deploy_method, #deploy_method_override, #deploy_started?, #deploy_timed_out?, #disappeared?, #exists?, #failure_message, #fetch_events, #file_path, #global?, #group, #id, #initialize, kind, #kubectl_resource_type, #observed_generation, #pretty_status, #pretty_timeout_type, #report_status_to_statsd, #selected?, #sensitive_template_content?, #server_dry_run_validated?, #server_dry_runnable_resource?, #sync_debug_info, #terminating?, timeout, #timeout, #timeout_message, #timeout_override, #to_kubeclient_resource, #use_generated_name, #uses_generate_name?, #validate_definition, #validation_error_msg, #validation_failed?, #version

Constructor Details

This class inherits a constructor from Krane::KubernetesResource

Instance Attribute Details

#pods ⇒ Object (readonly)

Returns the value of attribute pods.



8
9
10
 
# File 'lib/krane/kubernetes_resource/stateful_set.rb', line 8

def pods
  @pods
end

Instance Method Details

#deploy_failed? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
42
43
 
# File 'lib/krane/kubernetes_resource/stateful_set.rb', line 39

def deploy_failed?
  return false if update_strategy == ONDELETE
  pods.present? && pods.any?(&:deploy_failed?) &&
  observed_generation == current_generation
end

#deploy_succeeded? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/krane/kubernetes_resource/stateful_set.rb', line 21

def deploy_succeeded?
  if update_strategy == ONDELETE
    # Gem cannot monitor update since it doesn't occur until delete
    unless @success_assumption_warning_shown
      @logger.warn("WARNING: Your StatefulSet's updateStrategy is set to OnDelete, "\
                   "which means updates will not be applied until its pods are deleted. "\
                   "Consider switching to rollingUpdate.")
      @success_assumption_warning_shown = true
    end
    true
  else
    observed_generation == current_generation &&
    status_data['currentRevision'] == status_data['updateRevision'] &&
    desired_replicas == status_data['readyReplicas'].to_i &&
    desired_replicas == status_data['currentReplicas'].to_i
  end
end

#status ⇒ Object 



15
16
17
18
19
 
# File 'lib/krane/kubernetes_resource/stateful_set.rb', line 15

def status
  return super unless @instance_data["status"].present?
  rollout_data = @instance_data["status"].slice("replicas", "readyReplicas", "currentReplicas")
  rollout_data.map { |state_replicas, num| "#{num} #{state_replicas.chop.pluralize(num)}" }.join(", ")
end

#sync(cache) ⇒ Object 



10
11
12
13
 
# File 'lib/krane/kubernetes_resource/stateful_set.rb', line 10

def sync(cache)
  super
  @pods = exists? ? find_pods(cache) : []
end