PersistentVolumeClaimStatus

io.k8s.api.core.v1.PersistentVolumeClaimStatus source ↗

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

accessModes[]stringaccessModes contains the actual access modes the volume backing the PVC has.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
allocatedResourceStatusesmap[string]stringallocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either:
  • Un-prefixed keys:
  • storage - the capacity of the volume.
  • Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.ClaimResourceStatus can be in any of following states:
  • ControllerResizeInProgress:
State set when resize controller starts resizing the volume in control-plane.
  • ControllerResizeFailed:
State set when resize has failed in resize controller with a terminal error.
  • NodeResizePending:
State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node.
  • NodeResizeInProgress:
State set when kubelet starts resizing the volume.
  • NodeResizeFailed:
State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed. For example: if expanding a PVC for more capacity - this field can be one of the following states:
  • pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress"
  • pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed"
  • pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending"
  • pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress"
  • pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed"
When this field is not set, it means that no resize operation is in progress for the given PVC.A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.
allocatedResourcesmap[string]QuantityallocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either:
  • Un-prefixed keys:
  • storage - the capacity of the volume.
  • Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity.A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.
capacitymap[string]Quantitycapacity represents the actual resources of the underlying volume.
conditions[]PersistentVolumeClaimConditionconditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
lastProbeTimeTimelastProbeTime is the time we probed the condition.
lastTransitionTimeTimelastTransitionTime is the time the condition transitioned from one status to another.
messagestringmessage is the human-readable message indicating details about last transition.
reasonstringreason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent volume is being resized.
statusstring requiredStatus is the status of the condition. Can be True, False, Unknown.More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required
typestring requiredType is the type of the condition.More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about
currentVolumeAttributesClassNamestringcurrentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim
healthStatusVolumeHealthStatushealthStatus contains the latest controller-reported health information for the volume bound to this claim.
healthConditions[]VolumeHealthConditionconditions is the set of adverse conditions reported by the CSI controller plugin. An empty list means no adverse condition. At most 16 conditions may be reported.
messagestringmessage is a human-readable description. Maximum permitted length of a message is 1024 bytes.
reasonstring requiredreason is a brief CamelCase machine-parseable reason. Together with status it forms the unique identity of a condition entry. Maximum permitted length of a reason is 256 bytes.
statusstring requiredstatus is the machine-parseable health category. Possible values: - "Inaccessible": the volume cannot be accessed. - "DataLoss": data loss has been detected on the volume. - "Degraded": the volume is functioning with reduced capability.
lastTransitionTimeTimelastTransitionTime is when the current set of conditions first appeared.
modifyVolumeStatusModifyVolumeStatusModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.
statusstring requiredstatus is the status of the ControllerModifyVolume operation. It can be in any of following states:
  • Pending
Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing.
  • InProgress
InProgress indicates that the volume is being modified.
  • Infeasible
Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified. Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
targetVolumeAttributesClassNamestringtargetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
phasestringphase represents the current phase of PersistentVolumeClaim.