# PersistentVolume

PersistentVolumePersistentVolume (PV) is a storage resource provisioned by an administrator.apiVersion: v1import "k8s.io/api/core/v1"PersistentVolumePersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumesapiVersion: v1kind: PersistentVolumemetadata (ObjectMeta)Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (PersistentVolumeSpec)spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumesstatus (PersistentVolumeStatus)status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumesPersistentVolumeSpecPersistentVolumeSpec is the specification of a persistent volume.accessModes ([]string)Atomic: will be replaced during a mergeaccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modescapacity (map[string]Quantity)capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacityclaimRef (ObjectReference)claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#bindingmountOptions ([]string)Atomic: will be replaced during a mergemountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-optionsnodeAffinity (VolumeNodeAffinity)nodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.nodeAffinity.required (NodeSelector)required specifies hard node constraints that must be met.A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.nodeAffinity.required.nodeSelectorTerms ([]NodeSelectorTerm), requiredAtomic: will be replaced during a mergeRequired. A list of node selector terms. The terms are ORed.A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.nodeAffinity.required.nodeSelectorTerms.matchExpressions ([]NodeSelectorRequirement)Atomic: will be replaced during a mergeA list of node selector requirements by node's labels.nodeAffinity.required.nodeSelectorTerms.matchFields ([]NodeSelectorRequirement)Atomic: will be replaced during a mergeA list of node selector requirements by node's fields.persistentVolumeReclaimPolicy (string)persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaimingstorageClassName (string)storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.volumeAttributesClassName (string)Name of VolumeAttributesClass to which this persistent volume belongs. Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any VolumeAttributesClass. This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class. For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process.volumeMode (string)volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.LocalhostPath (HostPathVolumeSource)hostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpathRepresents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.hostPath.path (string), requiredpath of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpathhostPath.type (string)type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpathlocal (LocalVolumeSource)local represents directly-attached storage with node affinityLocal represents directly-attached storage with node affinitylocal.path (string), requiredpath of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).local.fsType (string)fsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified.Persistent volumesawsElasticBlockStore (AWSElasticBlockStoreVolumeSource)awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore*Represents a Persistent Disk resource in AWS.An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.*awsElasticBlockStore.volumeID (string), requiredvolumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstoreawsElasticBlockStore.fsType (string)fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstoreawsElasticBlockStore.partition (int32)partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).awsElasticBlockStore.readOnly (boolean)readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstoreazureDisk (AzureDiskVolumeSource)azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.azureDisk.diskName (string), requireddiskName is the Name of the data disk in the blob storageazureDisk.diskURI (string), requireddiskURI is the URI of data disk in the blob storageazureDisk.cachingMode (string)cachingMode is the Host Caching mode: None, Read Only, Read Write.azureDisk.fsType (string)fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.azureDisk.kind (string)kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to sharedazureDisk.readOnly (boolean)readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.azureFile (AzureFilePersistentVolumeSource)azureFile represents an Azure File Service mount on the host and bind mount to the pod. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.AzureFile represents an Azure File Service mount on the host and bind mount to the pod.azureFile.secretName (string), requiredsecretName is the name of secret that contains Azure Storage Account Name and KeyazureFile.shareName (string), requiredshareName is the azure Share NameazureFile.readOnly (boolean)readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.azureFile.secretNamespace (string)secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Podcephfs (CephFSPersistentVolumeSource)cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.cephfs.monitors ([]string), requiredAtomic: will be replaced during a mergemonitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-itcephfs.path (string)path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /cephfs.readOnly (boolean)readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-itcephfs.secretFile (string)secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-itcephfs.secretRef (SecretReference)secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-itSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespacecephfs.secretRef.name (string)name is unique within a namespace to reference a secret resource.cephfs.secretRef.namespace (string)namespace defines the space within which the secret name must be unique.cephfs.user (string)user is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-itcinder (CinderPersistentVolumeSource)cinder represents a cinder volume attached and mounted on kubelets host machine. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.mdRepresents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.cinder.volumeID (string), requiredvolumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.mdcinder.fsType (string)fsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.mdcinder.readOnly (boolean)readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.mdcinder.secretRef (SecretReference)secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack.SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespacecinder.secretRef.name (string)name is unique within a namespace to reference a secret resource.cinder.secretRef.namespace (string)namespace defines the space within which the secret name must be unique.csi (CSIPersistentVolumeSource)csi represents storage that is handled by an external CSI driver.Represents storage that is managed by an external CSI volume drivercsi.driver (string), requireddriver is the name of the driver to use for this volume. Required.csi.volumeHandle (string), requiredvolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.csi.controllerExpandSecretRef (SecretReference)controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespacecsi.controllerExpandSecretRef.name (string)name is unique within a namespace to reference a secret resource.csi.controllerExpandSecretRef.namespace (string)namespace defines the space within which the secret name must be unique.csi.controllerPublishSecretRef (SecretReference)controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespacecsi.controllerPublishSecretRef.name (string)name is unique within a namespace to reference a secret resource.csi.controllerPublishSecretRef.namespace (string)namespace defines the space within which the secret name must be unique.csi.fsType (string)fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".csi.nodeExpandSecretRef (SecretReference)nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed.SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespacecsi.nodeExpandSecretRef.name (string)name is unique within a namespace to reference a secret resource.csi.nodeExpandSecretRef.namespace (string)namespace defines the space within which the secret name must be unique.csi.nodePublishSecretRef (SecretReference)nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespacecsi.nodePublishSecretRef.name (string)name is unique within a namespace to reference a secret resource.csi.nodePublishSecretRef.namespace (string)namespace defines the space within which the secret name must be unique.csi.nodeStageSecretRef (SecretReference)nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespacecsi.nodeStageSecretRef.name (string)name is unique within a namespace to reference a secret resource.csi.nodeStageSecretRef.namespace (string)namespace defines the space within which the secret name must be unique.csi.readOnly (boolean)readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).csi.volumeAttributes (map[string]string)volumeAttributes of the volume to publish.fc (FCVolumeSource)fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.fc.fsType (string)fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.fc.lun (int32)lun is Optional: FC target lun numberfc.readOnly (boolean)readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.fc.targetWWNs ([]string)Atomic: will be replaced during a mergetargetWWNs is Optional: FC target worldwide names (WWNs)fc.wwids ([]string)Atomic: will be replaced during a mergewwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.flexVolume (FlexPersistentVolumeSource)flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.flexVolume.driver (string), requireddriver is the name of the driver to use for this volume.flexVolume.fsType (string)fsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.flexVolume.options (map[string]string)options is Optional: this field holds extra command options if any.flexVolume.readOnly (boolean)readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.flexVolume.secretRef (SecretReference)secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespaceflexVolume.secretRef.name (string)name is unique within a namespace to reference a secret resource.flexVolume.secretRef.namespace (string)namespace defines the space within which the secret name must be unique.flocker (FlockerVolumeSource)flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.flocker.datasetName (string)datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecatedflocker.datasetUUID (string)datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker datasetgcePersistentDisk (GCEPersistentDiskVolumeSource)gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk*Represents a Persistent Disk resource in Google Compute Engine.A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.*gcePersistentDisk.pdName (string), requiredpdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdiskgcePersistentDisk.fsType (string)fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdiskgcePersistentDisk.partition (int32)partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdiskgcePersistentDisk.readOnly (boolean)readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdiskglusterfs (GlusterfsPersistentVolumeSource)glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.mdRepresents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.glusterfs.endpoints (string), requiredendpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-podglusterfs.path (string), requiredpath is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-podglusterfs.endpointsNamespace (string)endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-podglusterfs.readOnly (boolean)readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-podiscsi (ISCSIPersistentVolumeSource)iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.iscsi.iqn (string), requirediqn is Target iSCSI Qualified Name.iscsi.lun (int32), requiredlun is iSCSI Target Lun number.iscsi.targetPortal (string), requiredtargetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).iscsi.chapAuthDiscovery (boolean)chapAuthDiscovery defines whether support iSCSI Discovery CHAP authenticationiscsi.chapAuthSession (boolean)chapAuthSession defines whether support iSCSI Session CHAP authenticationiscsi.fsType (string)fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsiiscsi.initiatorName (string)initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.iscsi.iscsiInterface (string)iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).iscsi.portals ([]string)Atomic: will be replaced during a mergeportals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).iscsi.readOnly (boolean)readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.iscsi.secretRef (SecretReference)secretRef is the CHAP Secret for iSCSI target and initiator authenticationSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespaceiscsi.secretRef.name (string)name is unique within a namespace to reference a secret resource.iscsi.secretRef.namespace (string)namespace defines the space within which the secret name must be unique.nfs (NFSVolumeSource)nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfsRepresents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.nfs.path (string), requiredpath that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfsnfs.server (string), requiredserver is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfsnfs.readOnly (boolean)readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfsphotonPersistentDisk (PhotonPersistentDiskVolumeSource)photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.Represents a Photon Controller persistent disk resource.photonPersistentDisk.pdID (string), requiredpdID is the ID that identifies Photon Controller persistent diskphotonPersistentDisk.fsType (string)fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.portworxVolume (PortworxVolumeSource)portworxVolume represents a portworx volume attached and mounted on kubelets host machine. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.PortworxVolumeSource represents a Portworx volume resource.portworxVolume.volumeID (string), requiredvolumeID uniquely identifies a Portworx volumeportworxVolume.fsType (string)fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.portworxVolume.readOnly (boolean)readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.quobyte (QuobyteVolumeSource)quobyte represents a Quobyte mount on the host that shares a pod's lifetime. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.quobyte.registry (string), requiredregistry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumesquobyte.volume (string), requiredvolume is a string that references an already created Quobyte volume by name.quobyte.group (string)group to map volume access to Default is no groupquobyte.readOnly (boolean)readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.quobyte.tenant (string)tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the pluginquobyte.user (string)user to map volume access to Defaults to serivceaccount userrbd (RBDPersistentVolumeSource)rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.mdRepresents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.rbd.image (string), requiredimage is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itrbd.monitors ([]string), requiredAtomic: will be replaced during a mergemonitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itrbd.fsType (string)fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbdrbd.keyring (string)keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itrbd.pool (string)pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itrbd.readOnly (boolean)readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itrbd.secretRef (SecretReference)secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itSecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespacerbd.secretRef.name (string)name is unique within a namespace to reference a secret resource.rbd.secretRef.namespace (string)namespace defines the space within which the secret name must be unique.rbd.user (string)user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itscaleIO (ScaleIOPersistentVolumeSource)scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.ScaleIOPersistentVolumeSource represents a persistent ScaleIO volumescaleIO.gateway (string), requiredgateway is the host address of the ScaleIO API Gateway.scaleIO.secretRef (SecretReference), requiredsecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespacescaleIO.secretRef.name (string)name is unique within a namespace to reference a secret resource.scaleIO.secretRef.namespace (string)namespace defines the space within which the secret name must be unique.scaleIO.system (string), requiredsystem is the name of the storage system as configured in ScaleIO.scaleIO.fsType (string)fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"scaleIO.protectionDomain (string)protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.scaleIO.readOnly (boolean)readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.scaleIO.sslEnabled (boolean)sslEnabled is the flag to enable/disable SSL communication with Gateway, default falsescaleIO.storageMode (string)storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.scaleIO.storagePool (string)storagePool is the ScaleIO Storage Pool associated with the protection domain.scaleIO.volumeName (string)volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.storageos (StorageOSPersistentVolumeSource)storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. More info: https://examples.k8s.io/volumes/storageos/README.mdRepresents a StorageOS persistent volume resource.storageos.fsType (string)fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.storageos.readOnly (boolean)readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.storageos.secretRef (ObjectReference)secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.storageos.volumeName (string)volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.storageos.volumeNamespace (string)volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.vsphereVolume (VsphereVirtualDiskVolumeSource)vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.Represents a vSphere volume resource.vsphereVolume.volumePath (string), requiredvolumePath is the path that identifies vSphere volume vmdkvsphereVolume.fsType (string)fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.vsphereVolume.storagePolicyID (string)storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.vsphereVolume.storagePolicyName (string)storagePolicyName is the storage Policy Based Management (SPBM) profile name.PersistentVolumeStatusPersistentVolumeStatus is the current status of a persistent volume.lastPhaseTransitionTime (Time)lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions.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.message (string)message is a human-readable message indicating details about why the volume is in this state.phase (string)phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phasereason (string)reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.PersistentVolumeListPersistentVolumeList is a list of PersistentVolume items.apiVersion: v1kind: PersistentVolumeListmetadata (ListMeta)Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kindsitems ([]PersistentVolume), requireditems is a list of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumesOperationsget read the specified PersistentVolumeHTTP RequestGET /api/v1/persistentvolumes/{name}Parametersname (in path): string, requiredname of the PersistentVolumepretty (in query): stringprettyResponse200 (PersistentVolume): OK401: Unauthorizedget read status of the specified PersistentVolumeHTTP RequestGET /api/v1/persistentvolumes/{name}/statusParametersname (in path): string, requiredname of the PersistentVolumepretty (in query): stringprettyResponse200 (PersistentVolume): OK401: Unauthorizedlist list or watch objects of kind PersistentVolumeHTTP RequestGET /api/v1/persistentvolumesParametersallowWatchBookmarks (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 (PersistentVolumeList): OK401: Unauthorizedcreate create a PersistentVolumeHTTP RequestPOST /api/v1/persistentvolumesParametersbody: PersistentVolume, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (PersistentVolume): OK201 (PersistentVolume): Created202 (PersistentVolume): Accepted401: Unauthorizedupdate replace the specified PersistentVolumeHTTP RequestPUT /api/v1/persistentvolumes/{name}Parametersname (in path): string, requiredname of the PersistentVolumebody: PersistentVolume, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (PersistentVolume): OK201 (PersistentVolume): Created401: Unauthorizedupdate replace status of the specified PersistentVolumeHTTP RequestPUT /api/v1/persistentvolumes/{name}/statusParametersname (in path): string, requiredname of the PersistentVolumebody: PersistentVolume, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (PersistentVolume): OK201 (PersistentVolume): Created401: Unauthorizedpatch partially update the specified PersistentVolumeHTTP RequestPATCH /api/v1/persistentvolumes/{name}Parametersname (in path): string, requiredname of the PersistentVolumebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (PersistentVolume): OK201 (PersistentVolume): Created401: Unauthorizedpatch partially update status of the specified PersistentVolumeHTTP RequestPATCH /api/v1/persistentvolumes/{name}/statusParametersname (in path): string, requiredname of the PersistentVolumebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (PersistentVolume): OK201 (PersistentVolume): Created401: Unauthorizeddelete delete a PersistentVolumeHTTP RequestDELETE /api/v1/persistentvolumes/{name}Parametersname (in path): string, requiredname of the PersistentVolumebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (PersistentVolume): OK202 (PersistentVolume): Accepted401: Unauthorizeddeletecollection delete collection of PersistentVolumeHTTP RequestDELETE /api/v1/persistentvolumesParametersbody: 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.