# PersistentVolumeClaim

PersistentVolumeClaimPersistentVolumeClaim is a user's request for and claim to a persistent volume.apiVersion: v1import "k8s.io/api/core/v1"PersistentVolumeClaimPersistentVolumeClaim is a user's request for and claim to a persistent volumeapiVersion: v1kind: PersistentVolumeClaimmetadata (ObjectMeta)Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (PersistentVolumeClaimSpec)spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaimsstatus (PersistentVolumeClaimStatus)status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaimsPersistentVolumeClaimSpecPersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributesaccessModes ([]string)Atomic: will be replaced during a mergeaccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1selector (LabelSelector)selector is a label query over volumes to consider for binding.resources (VolumeResourceRequirements)resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resourcesVolumeResourceRequirements describes the storage resource requirements for a volume.resources.limits (map[string]Quantity)Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/resources.requests (map[string]Quantity)Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/volumeName (string)volumeName is the binding reference to the PersistentVolume backing this claim.storageClassName (string)storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1volumeMode (string)volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.Beta leveldataSource (TypedLocalObjectReference)dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.dataSourceRef (TypedObjectReference)dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.TypedObjectReference contains enough information to let you locate the typed referenced objectdataSourceRef.kind (string), requiredKind is the type of resource being referenceddataSourceRef.name (string), requiredName is the name of resource being referenceddataSourceRef.apiGroup (string)APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.dataSourceRef.namespace (string)Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.volumeAttributesClassName (string)volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string or nil value indicates that no VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/PersistentVolumeClaimStatusPersistentVolumeClaimStatus is the current status of a persistent volume claim.accessModes ([]string)Atomic: will be replaced during a mergeaccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1allocatedResourceStatuses (map[string]string)allocatedResourceStatuses 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.This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.allocatedResources (map[string]Quantity)allocatedResources 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.This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.capacity (map[string]Quantity)capacity represents the actual resources of the underlying volume.conditions ([]PersistentVolumeClaimCondition)Patch strategy: merge on key typeMap: unique values on key type will be kept during a mergeconditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.PersistentVolumeClaimCondition contains details about state of pvcconditions.status (string), 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%20requiredconditions.type (string), 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%20aboutconditions.lastProbeTime (Time)lastProbeTime is the time we probed the condition.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.conditions.lastTransitionTime (Time)lastTransitionTime is the time the condition transitioned from one status to another.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.conditions.message (string)message is the human-readable message indicating details about last transition.conditions.reason (string)reason 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.currentVolumeAttributesClassName (string)currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaimmodifyVolumeStatus (ModifyVolumeStatus)ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted.ModifyVolumeStatus represents the status object of ControllerModifyVolume operationmodifyVolumeStatus.status (string), 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.modifyVolumeStatus.targetVolumeAttributesClassName (string)targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciledphase (string)phase represents the current phase of PersistentVolumeClaim.PersistentVolumeClaimListPersistentVolumeClaimList is a list of PersistentVolumeClaim items.apiVersion: v1kind: PersistentVolumeClaimListmetadata (ListMeta)Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kindsitems ([]PersistentVolumeClaim), requireditems is a list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaimsOperationsget read the specified PersistentVolumeClaimHTTP RequestGET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}Parametersname (in path): string, requiredname of the PersistentVolumeClaimnamespace (in path): string, requirednamespacepretty (in query): stringprettyResponse200 (PersistentVolumeClaim): OK401: Unauthorizedget read status of the specified PersistentVolumeClaimHTTP RequestGET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/statusParametersname (in path): string, requiredname of the PersistentVolumeClaimnamespace (in path): string, requirednamespacepretty (in query): stringprettyResponse200 (PersistentVolumeClaim): OK401: Unauthorizedlist list or watch objects of kind PersistentVolumeClaimHTTP RequestGET /api/v1/namespaces/{namespace}/persistentvolumeclaimsParametersnamespace (in path): string, requirednamespaceallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (PersistentVolumeClaimList): OK401: Unauthorizedlist list or watch objects of kind PersistentVolumeClaimHTTP RequestGET /api/v1/persistentvolumeclaimsParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (PersistentVolumeClaimList): OK401: Unauthorizedcreate create a PersistentVolumeClaimHTTP RequestPOST /api/v1/namespaces/{namespace}/persistentvolumeclaimsParametersnamespace (in path): string, requirednamespacebody: PersistentVolumeClaim, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (PersistentVolumeClaim): OK201 (PersistentVolumeClaim): Created202 (PersistentVolumeClaim): Accepted401: Unauthorizedupdate replace the specified PersistentVolumeClaimHTTP RequestPUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}Parametersname (in path): string, requiredname of the PersistentVolumeClaimnamespace (in path): string, requirednamespacebody: PersistentVolumeClaim, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (PersistentVolumeClaim): OK201 (PersistentVolumeClaim): Created401: Unauthorizedupdate replace status of the specified PersistentVolumeClaimHTTP RequestPUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/statusParametersname (in path): string, requiredname of the PersistentVolumeClaimnamespace (in path): string, requirednamespacebody: PersistentVolumeClaim, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (PersistentVolumeClaim): OK201 (PersistentVolumeClaim): Created401: Unauthorizedpatch partially update the specified PersistentVolumeClaimHTTP RequestPATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}Parametersname (in path): string, requiredname of the PersistentVolumeClaimnamespace (in path): string, requirednamespacebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (PersistentVolumeClaim): OK201 (PersistentVolumeClaim): Created401: Unauthorizedpatch partially update status of the specified PersistentVolumeClaimHTTP RequestPATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/statusParametersname (in path): string, requiredname of the PersistentVolumeClaimnamespace (in path): string, requirednamespacebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (PersistentVolumeClaim): OK201 (PersistentVolumeClaim): Created401: Unauthorizeddelete delete a PersistentVolumeClaimHTTP RequestDELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}Parametersname (in path): string, requiredname of the PersistentVolumeClaimnamespace (in path): string, requirednamespacebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (PersistentVolumeClaim): OK202 (PersistentVolumeClaim): Accepted401: Unauthorizeddeletecollection delete collection of PersistentVolumeClaimHTTP RequestDELETE /api/v1/namespaces/{namespace}/persistentvolumeclaimsParametersnamespace (in path): string, requirednamespacebody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.