PersistentVolumeList
io.k8s.api.core.v1.PersistentVolumeList
source ↗
PersistentVolumeList is a list of PersistentVolume items.
apiVersionstring = "v1"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resourcesitems[]PersistentVolume requireditems is a list of persistent volumes.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
apiVersionstring = "v1"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resourceskindstring = "PersistentVolume"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to.Cannot be updated. In CamelCase.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kindsmetadataObjectMetaStandard object's metadata.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
annotationsmap[string]stringAnnotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotationscreationTimestampTime read-onlyCreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.Populated by the system.Read-only. Null for lists.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadatadeletionGracePeriodSecondsinteger (int64) read-onlyNumber of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened.Read-only.deletionTimestampTime read-onlyDeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.Populated by the system when a graceful deletion is requested.Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadatafinalizers[]stringMust be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.generateNamestringGenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.If this field is specified and the generated name exists, the server will return a 409.Applied only if Name is not specified.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotencygenerationinteger (int64) read-onlyA sequence number representing a specific generation of the desired state.Populated by the system.Read-only.labelsmap[string]stringMap of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labelsmanagedFields[]ManagedFieldsEntryManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
apiVersionstringAPIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.fieldsTypestringFieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"fieldsV1FieldsV1FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.managerstringManager is an identifier of the workflow managing these fields.operationstringOperation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.subresourcestringSubresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.timeTimeTime is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.namestringName must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition.Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#namesnamespacestringNamespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.Must be a DNS_LABEL.Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespacesownerReferences[]OwnerReferenceList of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
apiVersionstring requiredAPI version of the referent.blockOwnerDeletionbooleanIf true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.controllerbooleanIf true, this reference points to the managing controller.kindstring requiredKind of the referent.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kindsnamestring requiredName of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#namesuidstring requiredUID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uidsresourceVersionstring read-onlyAn opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.Populated by the system.Read-only. Value must be treated as opaque by clients and .More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistencyselfLinkstring read-onlyDeprecated: selfLink is a legacy read-only field that is no longer populated by the system.uidstring read-onlyUID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system.Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uidsspecPersistentVolumeSpecspec 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-volumes
accessModes[]stringaccessModes contains all ways the volume can be mounted.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modesawsElasticBlockStoreAWSElasticBlockStoreVolumeSourceawsElasticBlockStore 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#awselasticblockstorepartitioninteger (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#awselasticblockstorevolumeIDstring requiredvolumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstoreazureDiskAzureDiskVolumeSourceazureDisk 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 storagediskURIstring requireddiskURI is the URI of data disk in the blob storagefsTypestringfsType 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 sharedreadOnlybooleanreadOnly 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 KeysecretNamespacestringsecretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the PodshareNamestring requiredshareName is the azure Share Namecapacitymap[string]Quantitycapacity is the description of the persistent volume's resources and capacity.More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacitycephfsCephFSPersistentVolumeSourcecephFS 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-itpathstringpath 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-itsecretFilestringsecretFile 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-itsecretRefSecretReferencesecretRef 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-itcinderCinderPersistentVolumeSourcecinder 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.mdreadOnlybooleanreadOnly 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.mdsecretRefSecretReferencesecretRef 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.mdclaimRefObjectReferenceclaimRef 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-kindsnamestringName of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#namesnamespacestringNamespace 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-consistencyuidstringUID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uidscsiCSIPersistentVolumeSourcecsi 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 numberreadOnlybooleanreadOnly 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 deprecateddatasetUUIDstringdatasetUUID is the UUID of the dataset. This is unique identifier of a Flocker datasetgcePersistentDiskGCEPersistentDiskVolumeSourcegcePersistentDisk 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#gcepersistentdiskpartitioninteger (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#gcepersistentdiskpdNamestring 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#gcepersistentdiskreadOnlybooleanreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdiskglusterfsGlusterfsPersistentVolumeSourceglusterfs 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-podendpointsNamespacestringendpointsNamespace 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-podpathstring requiredpath is the Glusterfs volume path.More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-podreadOnlybooleanreadOnly 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-podhostPathHostPathVolumeSourcehostPath 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#hostpathtypestringtype for HostPath Volume Defaults to ""More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpathiscsiISCSIPersistentVolumeSourceiscsi 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 authenticationchapAuthSessionbooleanchapAuthSession defines whether support iSCSI Session CHAP authenticationfsTypestringfsType 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#iscsiinitiatorNamestringinitiatorName 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-optionsnfsNFSVolumeSourcenfs 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#nfsreadOnlybooleanreadOnly 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#nfsserverstring requiredserver is the hostname or IP address of the NFS server.More info: https://kubernetes.io/docs/concepts/storage/volumes#nfsnodeAffinityVolumeNodeAffinitynodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. This field is mutable if MutablePVNodeAffinity feature gate is enabled.
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#reclaimingphotonPersistentDiskPhotonPersistentDiskVolumeSourcephotonPersistentDisk 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 diskportworxVolumePortworxVolumeSourceportworxVolume 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.
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 volumequobyteQuobyteVolumeSourcequobyte 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 groupreadOnlybooleanreadOnly 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 volumestenantstringtenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the pluginuserstringuser to map volume access to Defaults to serivceaccount uservolumestring 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#rbdimagestring requiredimage is the rados image name.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itkeyringstringkeyring 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-itmonitors[]string requiredmonitors is a collection of Ceph monitors.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itpoolstringpool is the rados pool name. Default is rbd.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itreadOnlybooleanreadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-itsecretRefSecretReferencesecretRef 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-itscaleIOScaleIOPersistentVolumeSourcescaleIO 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 falsestorageModestringstorageMode 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-kindsnamestringName of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#namesnamespacestringNamespace 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-consistencyuidstringUID of the referent.More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uidsvolumeNamestringvolumeName 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 vmdkstatusPersistentVolumeStatus read-onlystatus 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-volumes
lastPhaseTransitionTimeTime read-onlylastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions.messagestring read-onlymessage is a human-readable message indicating details about why the volume is in this state.phasestring read-onlyphase 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#phasereasonstring read-onlyreason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.kindstring = "PersistentVolumeList"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to.Cannot be updated. In CamelCase.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kindsmetadataListMetaStandard list metadata.More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
continuestringcontinue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.remainingItemCountinteger (int64)remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.resourceVersionstring read-onlyString that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server.Populated by the system.Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistencyselfLinkstring read-onlyDeprecated: selfLink is a legacy read-only field that is no longer populated by the system.shardInfoShardInfoshardInfo is set when the list is a filtered subset of the full collection, as selected by a shard selector on the request. It echoes back the selector so clients can verify which shard they received and merge sharded responses. Clients should not cache sharded list responses as a full representation of the collection.This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
selectorstring requiredselector is the shard selector string from the request, echoed back so clients can verify which shard they received and merge responses from multiple shards.