# Volume

VolumeVolume represents a named volume in a pod that may be accessed by any container in the pod.import "k8s.io/api/core/v1"VolumeVolume represents a named volume in a pod that may be accessed by any container in the pod.name (string), requiredname of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#namesExposed Persistent volumespersistentVolumeClaim (PersistentVolumeClaimVolumeSource)persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaimsPersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).persistentVolumeClaim.claimName (string), requiredclaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaimspersistentVolumeClaim.readOnly (boolean)readOnly Will force the ReadOnly setting in VolumeMounts. Default false.ProjectionsconfigMap (ConfigMapVolumeSource)configMap represents a configMap that should populate this volume*Adapts a ConfigMap into a volume.The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.*configMap.name (string)Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#namesconfigMap.optional (boolean)optional specify whether the ConfigMap or its keys must be definedconfigMap.defaultMode (int32)defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.configMap.items ([]KeyToPath)Atomic: will be replaced during a mergeitems if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.secret (SecretVolumeSource)secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret*Adapts a Secret into a volume.The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.*secret.secretName (string)secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secretsecret.optional (boolean)optional field specify whether the Secret or its keys must be definedsecret.defaultMode (int32)defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.secret.items ([]KeyToPath)Atomic: will be replaced during a mergeitems If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.downwardAPI (DownwardAPIVolumeSource)downwardAPI represents downward API about the pod that should populate this volumeDownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.downwardAPI.defaultMode (int32)Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.downwardAPI.items ([]DownwardAPIVolumeFile)Atomic: will be replaced during a mergeItems is a list of downward API volume fileprojected (ProjectedVolumeSource)projected items for all in one resources secrets, configmaps, and downward APIRepresents a projected volume sourceprojected.defaultMode (int32)defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.projected.sources ([]VolumeProjection)Atomic: will be replaced during a mergesources is the list of volume projections. Each entry in this list handles one source.Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.projected.sources.clusterTrustBundle (ClusterTrustBundleProjection)ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.Alpha, gated by the ClusterTrustBundleProjection feature gate.ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.Kubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.projected.sources.clusterTrustBundle.path (string), requiredRelative path from the volume root to write the bundle.projected.sources.clusterTrustBundle.labelSelector (LabelSelector)Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".projected.sources.clusterTrustBundle.name (string)Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.projected.sources.clusterTrustBundle.optional (boolean)If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.projected.sources.clusterTrustBundle.signerName (string)Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.projected.sources.configMap (ConfigMapProjection)configMap information about the configMap data to project*Adapts a ConfigMap into a projected volume.The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.*projected.sources.configMap.name (string)Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#namesprojected.sources.configMap.optional (boolean)optional specify whether the ConfigMap or its keys must be definedprojected.sources.configMap.items ([]KeyToPath)Atomic: will be replaced during a mergeitems if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.projected.sources.downwardAPI (DownwardAPIProjection)downwardAPI information about the downwardAPI data to projectRepresents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.projected.sources.downwardAPI.items ([]DownwardAPIVolumeFile)Atomic: will be replaced during a mergeItems is a list of DownwardAPIVolume fileprojected.sources.podCertificate (PodCertificateProjection)Projects an auto-rotating credential bundle (private key and certificate chain) that the pod can use either as a TLS client or server.Kubelet generates a private key and uses it to send a PodCertificateRequest to the named signer. Once the signer approves the request and issues a certificate chain, Kubelet writes the key and certificate chain to the pod filesystem. The pod does not start until certificates have been issued for each podCertificate projected volume source in its spec.Kubelet will begin trying to rotate the certificate at the time indicated by the signer using the PodCertificateRequest.Status.BeginRefreshAt timestamp.Kubelet can write a single file, indicated by the credentialBundlePath field, or separate files, indicated by the keyPath and certificateChainPath fields.The credential bundle is a single file in PEM format. The first PEM entry is the private key (in PKCS#8 format), and the remaining PEM entries are the certificate chain issued by the signer (typically, signers will return their certificate chain in leaf-to-root order).Prefer using the credential bundle format, since your application code can read it atomically. If you use keyPath and certificateChainPath, your application must make two separate file reads. If these coincide with a certificate rotation, it is possible that the private key and leaf certificate you read may not correspond to each other. Your application will need to check for this condition, and re-read until they are consistent.The named signer controls chooses the format of the certificate it issues; consult the signer implementation's documentation to learn how to use the certificates it issues.PodCertificateProjection provides a private key and X.509 certificate in the pod filesystem.projected.sources.podCertificate.keyType (string), requiredThe type of keypair Kubelet will generate for the pod.Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519".projected.sources.podCertificate.signerName (string), requiredKubelet's generated CSRs will be addressed to this signer.projected.sources.podCertificate.certificateChainPath (string)Write the certificate chain at this path in the projected volume.Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.projected.sources.podCertificate.credentialBundlePath (string)Write the credential bundle at this path in the projected volume.The credential bundle is a single file that contains multiple PEM blocks. The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private key.The remaining blocks are CERTIFICATE blocks, containing the issued certificate chain from the signer (leaf and any intermediates).Using credentialBundlePath lets your Pod's application code make a single atomic read that retrieves a consistent key and certificate chain. If you project them to separate files, your application code will need to additionally check that the leaf certificate was issued to the key.projected.sources.podCertificate.keyPath (string)Write the key at this path in the projected volume.Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and leaf certificate are consistent, because it is possible to read the files mid-rotation.projected.sources.podCertificate.maxExpirationSeconds (int32)maxExpirationSeconds is the maximum lifetime permitted for the certificate.Kubelet copies this value verbatim into the PodCertificateRequests it generates for this projection.If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver will reject values shorter than 3600 (1 hour). The maximum allowable value is 7862400 (91 days).The signer implementation is then free to issue a certificate with any lifetime shorter than MaxExpirationSeconds, but no shorter than 3600 seconds (1 hour). This constraint is enforced by kube-apiserver. kubernetes.io signers will never issue certificates with a lifetime longer than 24 hours.projected.sources.secret (SecretProjection)secret information about the secret data to project*Adapts a secret into a projected volume.The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.*projected.sources.secret.name (string)Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#namesprojected.sources.secret.optional (boolean)optional field specify whether the Secret or its key must be definedprojected.sources.secret.items ([]KeyToPath)Atomic: will be replaced during a mergeitems if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.projected.sources.serviceAccountToken (ServiceAccountTokenProjection)serviceAccountToken is information about the serviceAccountToken data to projectServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).projected.sources.serviceAccountToken.path (string), requiredpath is the path relative to the mount point of the file to project the token into.projected.sources.serviceAccountToken.audience (string)audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.projected.sources.serviceAccountToken.expirationSeconds (int64)expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.Local / Temporary DirectoryemptyDir (EmptyDirVolumeSource)emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydirRepresents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.emptyDir.medium (string)medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydiremptyDir.sizeLimit (Quantity)sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydirhostPath (HostPathVolumeSource)hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. 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#hostpathPersistent 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 (AzureFileVolumeSource)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.cephfs (CephFSVolumeSource)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 (LocalObjectReference)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-itcephfs.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 (CinderVolumeSource)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 is the 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 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 (LocalObjectReference)secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.csi (CSIVolumeSource)csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.Represents a source location of a volume to mount, managed by an external CSI drivercsi.driver (string), requireddriver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.csi.fsType (string)fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.csi.nodePublishSecretRef (LocalObjectReference)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 secret references are passed.csi.readOnly (boolean)readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).csi.volumeAttributes (map[string]string)volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.ephemeral (EphemeralVolumeSource)ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.A pod can use both types of ephemeral volumes and persistent volumes at the same time.Represents an ephemeral volume that is handled by a normal storage driver.ephemeral.volumeClaimTemplate (PersistentVolumeClaimTemplate)Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be \<pod name>-\<volume name> where \<volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.Required, must not be nil.PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.ephemeral.volumeClaimTemplate.spec (PersistentVolumeClaimSpec), requiredThe specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.ephemeral.volumeClaimTemplate.metadata (ObjectMeta)May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.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 (FlexVolumeSource)flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.FlexVolume represents a generic 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 (LocalObjectReference)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.flocker (FlockerVolumeSource)flocker represents a Flocker volume attached to a kubelet's host machine. 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. 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 (GlusterfsVolumeSource)glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.Represents 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.glusterfs.path (string), requiredpath is the Glusterfs volume path. 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 (ISCSIVolumeSource)iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsiRepresents 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 the target iSCSI Qualified Name.iscsi.lun (int32), requiredlun represents 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 (LocalObjectReference)secretRef is the CHAP Secret for iSCSI target and initiator authenticationimage (ImageVolumeSource)image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. The volume is resolved at pod startup depending on which PullPolicy value is provided:Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers[].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.ImageVolumeSource represents a image volume resource.image.pullPolicy (string)Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.image.reference (string)Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.nfs (NFSVolumeSource)nfs represents an NFS mount on the host that shares a pod's lifetime 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 (RBDVolumeSource)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.Represents 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 (LocalObjectReference)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-itrbd.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 (ScaleIOVolumeSource)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.ScaleIOVolumeSource represents a persistent ScaleIO volumescaleIO.gateway (string), requiredgateway is the host address of the ScaleIO API Gateway.scaleIO.secretRef (LocalObjectReference), requiredsecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.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 Flag 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 (StorageOSVolumeSource)storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.Represents 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 (LocalObjectReference)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.DeprecatedgitRepo (GitRepoVolumeSource)gitRepo represents a git repository at a particular revision. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.*Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.*gitRepo.repository (string), requiredrepository is the URLgitRepo.directory (string)directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.gitRepo.revision (string)revision is the commit hash for the specified revision.DownwardAPIVolumeFileDownwardAPIVolumeFile represents information to create the file containing the pod fieldpath (string), requiredRequired: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'fieldRef (ObjectFieldSelector)Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.mode (int32)Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.resourceFieldRef (ResourceFieldSelector)Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.KeyToPathMaps a string key to a path within a volume.key (string), requiredkey is the key to project.path (string), requiredpath is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.mode (int32)mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.This 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.