Class: Krane::PersistentVolumeClaim

Inherits:
KubernetesResource show all
Defined in:
lib/krane/kubernetes_resource/persistent_volume_claim.rb

Defined Under Namespace

Classes: StorageClass

Constant Summary collapse

TIMEOUT = 
5.minutes

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::SERVER_DRY_RUNNABLE, KubernetesResource::SERVER_DRY_RUN_DISABLED_ERROR, KubernetesResource::STANDARD_TIMEOUT_MESSAGE, KubernetesResource::TIMEOUT_OVERRIDE_ANNOTATION, KubernetesResource::TIMEOUT_OVERRIDE_ANNOTATION_DEPRECATED, KubernetesResource::TIMEOUT_OVERRIDE_ANNOTATION_SUFFIX, KubernetesResource::UNUSUAL_FAILURE_MESSAGE

Instance Attribute Summary

Attributes inherited from KubernetesResource

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

Instance Method Summary collapse

Methods inherited from KubernetesResource

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

Constructor Details

This class inherits a constructor from Krane::KubernetesResource

Instance Method Details

#deploy_failed? ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/krane/kubernetes_resource/persistent_volume_claim.rb', line 27

def deploy_failed?
  status == "Lost" || failure_message.present?
end

#deploy_succeeded? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/krane/kubernetes_resource/persistent_volume_claim.rb', line 15

def deploy_succeeded?
  return true if status == "Bound"

  # if the StorageClass has volumeBindingMode: WaitForFirstConsumer,
  # it won't bind until after a Pod mounts it. But it must be pre-deployed,
  # as the Pod requires it. So 'Pending' must be treated as a 'Success' state
  if storage_class&.volume_binding_mode == "WaitForFirstConsumer"
    return status == "Pending" || status == "Bound"
  end
  false
end

#failure_message ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/krane/kubernetes_resource/persistent_volume_claim.rb', line 31

def failure_message
  if storage_class_name.nil? && @storage_classes.count(&:default?) > 1
    "PVC has no StorageClass specified and there are multiple StorageClasses " \
    "annotated as default. This is an invalid cluster configuration."
  end
end

#status ⇒ Object 



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

def status
  exists? ? @instance_data["status"]["phase"] : "Not Found"
end

#sync(cache) ⇒ Object 



6
7
8
9
 
# File 'lib/krane/kubernetes_resource/persistent_volume_claim.rb', line 6

def sync(cache)
  super
  @storage_classes = cache.get_all("StorageClass").map { |sc| StorageClass.new(sc) }
end

#timeout_message ⇒ Object 



38
39
40
41
 
# File 'lib/krane/kubernetes_resource/persistent_volume_claim.rb', line 38

def timeout_message
  return STANDARD_TIMEOUT_MESSAGE unless storage_class_name.present? && !storage_class
  "PVC specified a StorageClass of #{storage_class_name} but the resource does not exist"
end