PersistentVolumeSpec

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

PersistentVolumeSpec is the specification of a persistent volume.

accessModes[]stringaccessModes contains all ways the volume can be mounted.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
awsElasticBlockStoreAWSElasticBlockStoreVolumeSourceawsElasticBlockStore 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
fsTypestringfsType 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#awselasticblockstore
partitioninteger (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).
readOnlybooleanreadOnly value true will force the readOnly setting in VolumeMounts.More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeIDstring requiredvolumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
azureDiskAzureDiskVolumeSourceazureDisk 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.
cachingModestringcachingMode is the Host Caching mode: None, Read Only, Read Write.
diskNamestring requireddiskName is the Name of the data disk in the blob storage
diskURIstring requireddiskURI is the URI of data disk in the blob storage
fsTypestringfsType 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.
kindstringkind 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 shared
readOnlybooleanreadOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
azureFileAzureFilePersistentVolumeSourceazureFile 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.
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretNamestring requiredsecretName is the name of secret that contains Azure Storage Account Name and Key
secretNamespacestringsecretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
shareNamestring requiredshareName is the azure Share Name
capacitymap[string]Quantitycapacity is the description of the persistent volume's resources and capacity.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
cephfsCephFSPersistentVolumeSourcecephFS 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.
monitors[]string requiredmonitors is Required: Monitors is a collection of Ceph monitorsMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
pathstringpath is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
readOnlybooleanreadOnly 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-it
secretFilestringsecretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secretMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
secretRefSecretReferencesecretRef 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-it
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
userstringuser is Optional: User is the rados user name, default is adminMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
cinderCinderPersistentVolumeSourcecinder 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.md
fsTypestringfsType 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.md
readOnlybooleanreadOnly 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.md
secretRefSecretReferencesecretRef is Optional: points to a secret object containing parameters used to connect to OpenStack.
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
volumeIDstring requiredvolumeID used to identify the volume in cinder.More info: https://examples.k8s.io/mysql-cinder-pd/README.md
claimRefObjectReferenceclaimRef 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#binding
apiVersionstringAPI version of the referent.
fieldPathstringIf referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kindstringKind of the referent.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestringName of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespacestringNamespace of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersionstringSpecific resourceVersion to which this reference is made, if any.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
uidstringUID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
csiCSIPersistentVolumeSourcecsi represents storage that is handled by an external CSI driver.
controllerExpandSecretRefSecretReferencecontrollerExpandSecretRef 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.
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
controllerPublishSecretRefSecretReferencecontrollerPublishSecretRef 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.
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
driverstring requireddriver is the name of the driver to use for this volume. Required.
fsTypestringfsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
nodeExpandSecretRefSecretReferencenodeExpandSecretRef 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.
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
nodePublishSecretRefSecretReferencenodePublishSecretRef 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.
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
nodeStageSecretRefSecretReferencenodeStageSecretRef 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.
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
readOnlybooleanreadOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
volumeAttributesmap[string]stringvolumeAttributes of the volume to publish.
volumeHandlestring requiredvolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
fcFCVolumeSourcefc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
fsTypestringfsType 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.
luninteger (int32)lun is Optional: FC target lun number
readOnlybooleanreadOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs[]stringtargetWWNs is Optional: FC target worldwide names (WWNs)
wwids[]stringwwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
flexVolumeFlexPersistentVolumeSourceflexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
driverstring requireddriver is the name of the driver to use for this volume.
fsTypestringfsType 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.
optionsmap[string]stringoptions is Optional: this field holds extra command options if any.
readOnlybooleanreadOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefSecretReferencesecretRef 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.
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
flockerFlockerVolumeSourceflocker 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.
datasetNamestringdatasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUIDstringdatasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
gcePersistentDiskGCEPersistentDiskVolumeSourcegcePersistentDisk 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
fsTypestringfsType 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#gcepersistentdisk
partitioninteger (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#gcepersistentdisk
pdNamestring 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#gcepersistentdisk
readOnlybooleanreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
glusterfsGlusterfsPersistentVolumeSourceglusterfs 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.md
endpointsstring requiredendpoints is the endpoint name that details Glusterfs topology.More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
endpointsNamespacestringendpointsNamespace 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-pod
pathstring requiredpath is the Glusterfs volume path.More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnlybooleanreadOnly 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-pod
hostPathHostPathVolumeSourcehostPath 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#hostpath
pathstring 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#hostpath
typestringtype for HostPath Volume Defaults to ""More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
iscsiISCSIPersistentVolumeSourceiscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
chapAuthDiscoverybooleanchapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chapAuthSessionbooleanchapAuthSession defines whether support iSCSI Session CHAP authentication
fsTypestringfsType 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#iscsi
initiatorNamestringinitiatorName 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.
iqnstring requirediqn is Target iSCSI Qualified Name.
iscsiInterfacestringiscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
luninteger (int32) requiredlun is iSCSI Target Lun number.
portals[]stringportals 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).
readOnlybooleanreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRefSecretReferencesecretRef is the CHAP Secret for iSCSI target and initiator authentication
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
targetPortalstring 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).
localLocalVolumeSourcelocal represents directly-attached storage with node affinity
fsTypestringfsType 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.
pathstring requiredpath of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
mountOptions[]stringmountOptions 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-options
nfsNFSVolumeSourcenfs represents an NFS mount on the host. Provisioned by an admin.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
pathstring requiredpath that is exported by the NFS server.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnlybooleanreadOnly 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#nfs
serverstring requiredserver is the hostname or IP address of the NFS server.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
nodeAffinityVolumeNodeAffinitynodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
requiredNodeSelectorrequired specifies hard node constraints that must be met.
nodeSelectorTerms[]NodeSelectorTerm requiredRequired. A list of node selector terms. The terms are ORed.
matchExpressions[]NodeSelectorRequirementA list of node selector requirements by node's labels.
keystring requiredThe label key that the selector applies to.
operatorstring requiredRepresents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values[]stringAn array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
matchFields[]NodeSelectorRequirementA list of node selector requirements by node's fields.
keystring requiredThe label key that the selector applies to.
operatorstring requiredRepresents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values[]stringAn array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
persistentVolumeReclaimPolicystringpersistentVolumeReclaimPolicy 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#reclaiming
photonPersistentDiskPhotonPersistentDiskVolumeSourcephotonPersistentDisk 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.
fsTypestringfsType 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.
pdIDstring requiredpdID is the ID that identifies Photon Controller persistent disk
portworxVolumePortworxVolumeSourceportworxVolume 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.
fsTypestringfSType 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.
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeIDstring requiredvolumeID uniquely identifies a Portworx volume
quobyteQuobyteVolumeSourcequobyte 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.
groupstringgroup to map volume access to Default is no group
readOnlybooleanreadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
registrystring 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 volumes
tenantstringtenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
userstringuser to map volume access to Defaults to serivceaccount user
volumestring requiredvolume is a string that references an already created Quobyte volume by name.
rbdRBDPersistentVolumeSourcerbd 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.md
fsTypestringfsType 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#rbd
imagestring requiredimage is the rados image name.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
keyringstringkeyring 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-it
monitors[]string requiredmonitors is a collection of Ceph monitors.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
poolstringpool is the rados pool name. Default is rbd.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
readOnlybooleanreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
secretRefSecretReferencesecretRef 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-it
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
userstringuser is the rados user name. Default is admin.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
scaleIOScaleIOPersistentVolumeSourcescaleIO 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.
fsTypestringfsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
gatewaystring requiredgateway is the host address of the ScaleIO API Gateway.
protectionDomainstringprotectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefSecretReference requiredsecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
namestringname is unique within a namespace to reference a secret resource.
namespacestringnamespace defines the space within which the secret name must be unique.
sslEnabledbooleansslEnabled is the flag to enable/disable SSL communication with Gateway, default false
storageModestringstorageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePoolstringstoragePool is the ScaleIO Storage Pool associated with the protection domain.
systemstring requiredsystem is the name of the storage system as configured in ScaleIO.
volumeNamestringvolumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
storageClassNamestringstorageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
storageosStorageOSPersistentVolumeSourcestorageOS 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.md
fsTypestringfsType 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.
readOnlybooleanreadOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRefObjectReferencesecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
apiVersionstringAPI version of the referent.
fieldPathstringIf referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kindstringKind of the referent.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestringName of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespacestringNamespace of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceVersionstringSpecific resourceVersion to which this reference is made, if any.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
uidstringUID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
volumeNamestringvolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespacestringvolumeNamespace 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.
volumeAttributesClassNamestringName 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.
volumeModestringvolumeMode 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.
vsphereVolumeVsphereVirtualDiskVolumeSourcevsphereVolume 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.
fsTypestringfsType 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.
storagePolicyIDstringstoragePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyNamestringstoragePolicyName is the storage Policy Based Management (SPBM) profile name.
volumePathstring requiredvolumePath is the path that identifies vSphere volume vmdk