This section of the Kubernetes documentation provides reference details of Kubernetes storage.
This is the multi-page printable view of this section. Click here to print.
Storage Reference
- 1: Volume Types
1 - Volume Types
This page lists details for every in-tree volume type, including those that have been deprecated and removed.
For CSI and FlexVolume, see Out-of-tree volume plugins.
For more on volumes, see Volumes.
configMap
A ConfigMap
provides a way to inject configuration data into Pods.
The data stored in a ConfigMap can be referenced in a volume of type
configMap and then consumed by containerized applications running in a Pod.
When referencing a ConfigMap, you provide the name of the ConfigMap in the
volume. You can customize the path to use for a specific
entry in the ConfigMap. The following configuration shows how to mount
the log-config ConfigMap onto a Pod called configmap-pod:
apiVersion: v1
kind: Pod
metadata:
name: configmap-pod
spec:
containers:
- name: test
image: busybox:1.28
command: ['sh', '-c', 'echo "The app is running!" && tail -f /dev/null']
volumeMounts:
- name: config-vol
mountPath: /etc/config
volumes:
- name: config-vol
configMap:
name: log-config
items:
- key: log_level
path: log_level.conf
The log-config ConfigMap is mounted as a volume, and all contents stored in
its log_level entry are mounted into the Pod at path /etc/config/log_level.conf.
Note that this path is derived from the volume's mountPath and the path
keyed with log_level.
Note:
You must create a ConfigMap before you can use it.
A ConfigMap is always mounted as
readOnly.A container using a ConfigMap as a
subPathvolume mount will not receive updates when the ConfigMap changes.Text data is exposed as files using the UTF-8 character encoding. For other character encodings, use
binaryData.
downwardAPI
A downwardAPI volume makes downward API
data available to applications. For more details, see
Downward API.
Note:
A container using the downward API as asubPath volume mount does not
receive updates when field values change.emptyDir
For a Pod that defines an emptyDir volume, the volume is created when the Pod is assigned to a node.
As the name says, the emptyDir volume is initially empty. All containers in the Pod can read and write the same
files in the emptyDir volume, though that volume can be mounted at the same
or different paths in each container. When a Pod is removed from a node for
any reason, the data in the emptyDir is deleted permanently.
Note:
A container crashing does not remove a Pod from a node. The data in anemptyDir volume
is safe across container crashes.Some uses for an emptyDir are:
- scratch space, such as for a disk-based merge sort
- checkpointing a long computation for recovery from crashes
- holding files that a content-manager container fetches while a webserver container serves the data
The emptyDir.medium field controls where emptyDir volumes are stored. By
default emptyDir volumes are stored on whatever medium that backs the node
such as disk, SSD, or network storage, depending on your environment. If you set
the emptyDir.medium field to "Memory", Kubernetes mounts a tmpfs (RAM-backed
filesystem) for you instead. While tmpfs is very fast, be aware that, unlike
disks, files you write count against the memory limit of the container that wrote them.
A size limit can be specified for the default medium, which limits the capacity
of the emptyDir volume. The storage is allocated from
node ephemeral storage.
If that is filled up from another source (for example, log files or image overlays),
the emptyDir may run out of capacity before this limit.
If no size is specified, memory-backed volumes are sized to node allocatable memory.
Caution:
Please check here for points to note in terms of resource management when using memory-backedemptyDir.More information about this feature
To use this feature, you (or a cluster administrator) will need to enable the EmptyDirVolumeMode feature gate for all relevant components in your cluster.
See Enable Or Disable Feature Gates for more information.
The emptyDir.mode field lets you set Unix permission bits on the emptyDir directory,
specifying a value between 0000 and 01777 (octal). This follows the same pattern as the
defaultMode field on Secret and ConfigMap volumes. If mode is not specified, the
directory is created with the default 0777 permissions.
Setting a custom mode is useful when you want to restrict access to owner and group only
(for example, 0750), or set the sticky bit on a shared directory so that only file owners
can delete their own files (for example, 01777).
Note:
IffsGroup is set in the Pod's security context, the group permissions applied by
fsGroup override the mode specified here. The mode field has no effect on Windows.emptyDir configuration example
apiVersion: v1
kind: Pod
metadata:
name: test-pd
spec:
containers:
- image: registry.k8s.io/test-webserver
name: test-container
volumeMounts:
- mountPath: /cache
name: cache-volume
volumes:
- name: cache-volume
emptyDir:
sizeLimit: 500Mi
emptyDir memory configuration example
apiVersion: v1
kind: Pod
metadata:
name: test-pd
spec:
containers:
- image: registry.k8s.io/test-webserver
name: test-container
volumeMounts:
- mountPath: /cache
name: cache-volume
volumes:
- name: cache-volume
emptyDir:
sizeLimit: 500Mi
medium: Memory
emptyDir and in-place Pod resizing
More information about this feature
To use this feature, you (or a cluster administrator) will need to enable the InPlacePodVerticalScalingMemoryBackedVolumes feature gate for all relevant components in your cluster.
See Enable Or Disable Feature Gates for more information.
When the InPlacePodVerticalScalingMemoryBackedVolumes feature gate is enabled, you can dynamically adjust the sizeLimit of memory-backed (medium: Memory) emptyDir volumes, without restarting the Pod or its containers.
For more details, see Resize CPU and Memory Resources assigned to Containers.
emptyDir permissions configuration example
apiVersion: v1
kind: Pod
metadata:
name: test-pd
spec:
containers:
- image: registry.k8s.io/test-webserver
name: test-container
volumeMounts:
- mountPath: /cache
name: cache-volume
volumes:
- name: cache-volume
emptyDir:
mode: 01777
ephemeral
An ephemeral volume is a temporary volume that Kubernetes creates and
deletes with the lifecycle of the pod.
For more details, see
generic ephemeral volumes.
fc (fibre channel)
An fc volume type allows an existing fibre channel block storage volume
to be mounted in a Pod. You can specify single or multiple target world wide names (WWNs)
using the parameter targetWWNs in your Volume configuration. If multiple WWNs are specified,
targetWWNs expect that those WWNs are from multi-path connections.
Note:
You must configure FC SAN Zoning to allocate and mask those LUNs (volumes) to the target WWNs beforehand so that Kubernetes hosts can access them.gitRepo (disabled)
Warning:
Kubernetes 1.37 does not include the gitRepo volume
driver. The last version that provided a way to use this driver was Kubernetes
v1.35, and it has been deprecated since the v1.11 minor
release.
To provision a Pod that has a Git repository mounted, you can mount an
emptyDir volume into an init container
that clones the repo using Git, then mount the EmptyDir into the Pod's container.
You can restrict the use of gitRepo volumes in your cluster using
policies, such as
ValidatingAdmissionPolicy.
You can use the following Common Expression Language (CEL) expression as
part of a policy to reject use of gitRepo volumes:
!has(object.spec.volumes) || !object.spec.volumes.exists(v, has(v.gitRepo))
hostPath
A hostPath volume mounts a file or directory from the host node's filesystem
into your Pod. This is not something that most Pods will need, but it offers a
powerful escape hatch for some applications.
Warning:
Using the hostPath volume type presents many security risks.
If you can avoid using a hostPath volume, you should. For example,
define a local PersistentVolume, and use that instead.
If you are restricting access to specific directories on the node using
admission-time validation, that restriction is only effective when you
additionally require that any mounts of that hostPath volume are
read only. If you allow a read-write mount of any host path by an
untrusted Pod, the containers in that Pod may be able to subvert the
read-write host mount.
Take care when using hostPath volumes, whether these are mounted as read-only
or as read-write, because:
- Access to the host filesystem can expose privileged system credentials (such as for the kubelet) or privileged APIs (such as the container runtime socket) that can be used for container escape or to attack other parts of the cluster.
- Pods with identical configuration (such as created from a PodTemplate) may behave differently on different nodes due to different files on the nodes.
hostPathvolume usage is not treated as ephemeral storage usage. You need to monitor the disk usage by yourself because excessivehostPathdisk usage will lead to disk pressure on the node.
Some uses for a hostPath are:
- running a container that needs access to node-level system components
(such as a container that transfers system logs to a central location,
accessing those logs using a read-only mount of
/var/log) - making a configuration file stored on the host system available read-only to a static Pod; unlike normal Pods, static Pods cannot access ConfigMaps
hostPath volume types
In addition to the required path property, you can optionally specify a
type for a hostPath volume.
The available values for type are:
| Value | Behavior |
|---|---|
"" | Empty string (default) is for backward compatibility, which means that no checks will be performed before mounting the hostPath volume. |
DirectoryOrCreate | If nothing exists at the given path, an empty directory will be created there as needed with permission set to 0755, having the same group and ownership with Kubelet. |
Directory | A directory must exist at the given path. |
FileOrCreate | If nothing exists at the given path, an empty file will be created there as needed with permission set to 0644, having the same group and ownership with Kubelet. |
File | A file must exist at the given path. |
Socket | A UNIX socket must exist at the given path. |
CharDevice | (Linux nodes only) A character device must exist at the given path. |
BlockDevice | (Linux nodes only) A block device must exist at the given path. |
Caution:
TheFileOrCreate mode does not create the parent directory of the file. If the parent directory
of the mounted file does not exist, the Pod fails to start. To ensure that this mode works,
you can try to mount directories and files separately, as shown in the
FileOrCreate example for hostPath.Some files or directories created on the underlying hosts might only be
accessible by root. You then either need to run your process as root in a
privileged container
or modify the file permissions on the host to read from or write to a hostPath volume.
hostPath configuration example
---
# This manifest mounts /data/foo on the host as /foo inside the
# single container that runs within the hostpath-example-linux Pod.
#
# The mount into the container is read-only.
apiVersion: v1
kind: Pod
metadata:
name: hostpath-example-linux
spec:
os: { name: linux }
nodeSelector:
kubernetes.io/os: linux
containers:
- name: example-container
image: registry.k8s.io/test-webserver
volumeMounts:
- mountPath: /foo
name: example-volume
readOnly: true
volumes:
- name: example-volume
# mount /data/foo, but only if that directory already exists
hostPath:
path: /data/foo # directory location on host
type: Directory # this field is optional
---
# This manifest mounts C:\Data\foo on the host as C:\foo, inside the
# single container that runs within the hostpath-example-windows Pod.
#
# The mount into the container is read-only.
apiVersion: v1
kind: Pod
metadata:
name: hostpath-example-windows
spec:
os: { name: windows }
nodeSelector:
kubernetes.io/os: windows
containers:
- name: example-container
image: microsoft/windowsservercore:1709
volumeMounts:
- name: example-volume
mountPath: "C:\\foo"
readOnly: true
volumes:
# mount C:\Data\foo from the host, but only if that directory already exists
- name: example-volume
hostPath:
path: "C:\\Data\\foo" # directory location on host
type: Directory # this field is optional
hostPath FileOrCreate configuration example
The following manifest defines a Pod that mounts /var/local/aaa
inside the single container in the Pod. If the node does not
already have a path /var/local/aaa, the kubelet creates
it as a directory and then mounts it into the Pod.
If /var/local/aaa already exists but is not a directory,
the Pod fails. Additionally, the kubelet attempts to make
a file named /var/local/aaa/1.txt inside that directory
(as seen from the host); if something already exists at
that path and isn't a regular file, the Pod fails.
Here's the example manifest:
apiVersion: v1
kind: Pod
metadata:
name: test-webserver
spec:
os: { name: linux }
nodeSelector:
kubernetes.io/os: linux
containers:
- name: test-webserver
image: registry.k8s.io/test-webserver:latest
volumeMounts:
- mountPath: /var/local/aaa
name: mydir
- mountPath: /var/local/aaa/1.txt
name: myfile
volumes:
- name: mydir
hostPath:
# Ensure the file directory is created.
path: /var/local/aaa
type: DirectoryOrCreate
- name: myfile
hostPath:
path: /var/local/aaa/1.txt
type: FileOrCreate
image
More information about this feature
This is a stable feature in Kubernetes, and has been since version 1.36. It was first available in the v1.31 release.
An image volume source represents an OCI object (a container image or
artifact) which is available on the kubelet's host machine.
An example of using the image volume source is:
apiVersion: v1
kind: Pod
metadata:
name: image-volume
spec:
containers:
- name: shell
command: ["sleep", "infinity"]
image: debian
volumeMounts:
- name: volume
mountPath: /volume
volumes:
- name: volume
image:
reference: quay.io/crio/artifact:v2
pullPolicy: IfNotPresent
The volume is resolved at Pod startup, depending on which pullPolicy value is
provided:
Always- The kubelet always attempts to pull the reference. If the pull fails,
the kubelet sets the Pod to
Failed. Never- The kubelet never pulls the reference and only uses a local image or artifact.
The Pod becomes
Failedif any layers of the image aren't already present locally, or if the manifest for that image isn't already cached. IfNotPresent- The kubelet pulls if the reference isn't already present on disk. The Pod becomes
Failedif 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. At a minimum, they must include
all valid types supported by the container image field. The OCI object gets
mounted in a single directory (spec.containers[*].volumeMounts[*].mountPath)
and will be mounted read-only.
Besides that:
subPathorsubPathExprmounts for containers (spec.containers[*].volumeMounts[*].subPath,spec.containers[*].volumeMounts[*].subPathExpr) are only supported from Kubernetes v1.33.- The field
spec.securityContext.fsGroupChangePolicyhas no effect on this volume type. - The
AlwaysPullImagesAdmission Controller does also work for this volume source like for container images.
The following fields are available for the image type:
reference- Artifact reference to be used. For example, you could specify
registry.k8s.io/conformance:v1.37.0to load the files from the Kubernetes conformance test image. Behaves in the same way aspod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, service account image pull secrets, and Pod spec image pull secrets. This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. More info about container images. pullPolicy- Policy for pulling OCI objects. Possible values are:
Always,Never, orIfNotPresent. Defaults toAlwaysif:latesttag is specified, orIfNotPresentotherwise.
See the Use an Image Volume With a Pod example for more details on how to use the volume source.
Pod status and image volumes
More information about this feature
To use this feature, you (or a cluster administrator) will need to enable the ImageVolumeWithDigest feature gate for all relevant components in your cluster.
See Enable Or Disable Feature Gates for more information.
If the ImageVolumeWithDigest feature gate
is enabled in your cluster,
then whenever you specify an image volume for a Pod,
the kubelet updates the Pod status to record the digest
of the container image that's being used as a volume source.
Here's a simplified example of a running Pod, represented as YAML, including the status update.
Note the new ImageRef field under volumeMounts in the container status.
apiVersion: v1
kind: Pod
metadata:
name: my-pod
namespace: default
spec:
containers:
- name: shell
command: ["sleep", "infinity"]
image: docker.io/library/debian:12
volumeMounts:
- name: artifact
mountPath: /data
volumes:
- name: artifact
image:
reference: quay.io/crio/artifact:v2
pullPolicy: IfNotPresent
status:
containerStatuses:
- containerID: containerd://examplecontainerid1234567890abcdef
image: docker.io/library/debian:12
imageID: docker-pullable://docker.io/library/debian@sha256:3f1d6c17773a45c97bd8f158d665c9709d7b29ed7917ac934086ad96f92e4510
volumeMounts:
- name: artifact
mountPath: /data
readOnly: true
imageRef: quay.io/crio/artifact@sha256:abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890
iscsi
An iscsi volume allows an existing iSCSI (SCSI over IP) volume to be mounted
into your Pod. Unlike emptyDir, which is erased when a Pod is removed, the
contents of an iscsi volume are preserved, and the volume is merely
unmounted. This means that an iscsi volume can be pre-populated with data, and
that data can be shared between Pods.
Note:
You must have your own iSCSI server running with the volume created before you can use it.A feature of iSCSI is that it can be mounted as read-only by multiple consumers simultaneously. This means that you can pre-populate a volume with your dataset and then serve it in parallel from as many Pods as you need. Unfortunately, iSCSI volumes can only be mounted by a single consumer in read-write mode. Simultaneous writers are not allowed.
local
A local volume represents a mounted local storage device such as a disk,
partition or directory.
Local volumes can only be used as a statically created PersistentVolume. Dynamic provisioning is not supported.
Compared to hostPath volumes, local volumes are used in a durable and
portable manner without manually scheduling Pods to nodes. The system is aware
of the volume's node constraints by looking at the node affinity on the PersistentVolume.
However, local volumes are subject to the availability of the underlying
node and are not suitable for all applications. If a node becomes unhealthy,
then the local volume becomes inaccessible to the Pod. The Pod using this volume
is unable to run. Applications using local volumes must be able to tolerate this
reduced availability, as well as potential data loss, depending on the
durability characteristics of the underlying disk.
The following example shows a PersistentVolume using a local volume and
nodeAffinity:
apiVersion: v1
kind: PersistentVolume
metadata:
name: example-pv
spec:
capacity:
storage: 100Gi
volumeMode: Filesystem
accessModes:
- ReadWriteOnce
persistentVolumeReclaimPolicy: Delete
storageClassName: local-storage
local:
path: /mnt/disks/ssd1
nodeAffinity:
required:
nodeSelectorTerms:
- matchExpressions:
- key: kubernetes.io/hostname
operator: In
values:
- example-node
You must set a PersistentVolume nodeAffinity when using local volumes.
The Kubernetes scheduler uses the PersistentVolume nodeAffinity to schedule
these Pods to the correct node.
PersistentVolume volumeMode can be set to "Block" (instead of the default
value "Filesystem") to expose the local volume as a raw block device.
When using local volumes, it is recommended to create a StorageClass with
volumeBindingMode set to WaitForFirstConsumer. For more details, see the
local StorageClass example.
Delaying volume binding ensures that the PersistentVolumeClaim binding decision
will also be evaluated with any other node constraints the Pod may have,
such as node resource requirements, node selectors, Pod affinity, and Pod anti-affinity.
An external static provisioner can be run separately for improved management of the local volume lifecycle. Note that this provisioner does not support dynamic provisioning yet. For an example on how to run an external local provisioner, see the local volume provisioner user guide.
Note:
The local PersistentVolume requires manual cleanup and deletion by the user if the external static provisioner is not used to manage the volume lifecycle.nfs
An nfs volume allows an existing NFS (Network File System) share to be
mounted into a Pod. Unlike emptyDir, which is erased when a Pod is
removed, the contents of an nfs volume are preserved, and the volume is merely
unmounted. This means that an NFS volume can be pre-populated with data, and
that data can be shared between Pods. NFS can be mounted by multiple
writers simultaneously.
apiVersion: v1
kind: Pod
metadata:
name: test-pd
spec:
containers:
- image: registry.k8s.io/test-webserver
name: test-container
volumeMounts:
- mountPath: /my-nfs-data
name: test-volume
volumes:
- name: test-volume
nfs:
server: my-nfs-server.example.com
path: /my-nfs-volume
readOnly: true
Note:
You must have your own NFS server running with the share exported before you can use it.
Also note that you can't specify NFS mount options in a Pod spec. You can either set mount options server-side or use /etc/nfsmount.conf. You can also mount NFS volumes via PersistentVolumes, which do allow you to set mount options.
persistentVolumeClaim
A persistentVolumeClaim volume is used to mount a
PersistentVolume into a Pod. PersistentVolumeClaims
are a way for users to "claim" durable storage (such as an iSCSI volume)
without knowing the details of the particular cloud environment.
See the information about PersistentVolumes for more details.
projected
A projected volume maps several existing volume sources into the same directory. For more details, see projected volumes.
secret
A secret volume is used to pass sensitive information, such as passwords, to
Pods. You can store secrets in the Kubernetes API and mount them as files for
use by Pods without coupling to Kubernetes directly. secret volumes are
backed by tmpfs (a RAM-backed filesystem), so they are never written to
non-volatile storage.
Note:
You must create a Secret in the Kubernetes API before you can use it.
A Secret is always mounted as
readOnly.A container using a Secret as a
subPathvolume mount will not receive Secret updates.
For more details, see Configuring Secrets.
Removed volume types
Kubernetes 1.37 does not include the in-tree drivers for the following volume types, though their fields still exist in the Pod API. Some of these types are redirected to a CSI driver.
awsElasticBlockStore (removed)
The in-tree awsElasticBlockStore driver was removed in Kubernetes v1.27.
Kubernetes redirects all operations for this type to the ebs.csi.aws.com
CSI driver.
Use the
AWS EBS CSI driver instead.
azureDisk (removed)
The in-tree azureDisk driver was removed in Kubernetes v1.27.
Kubernetes redirects all operations for this type to the disk.csi.azure.com
CSI driver.
Use the
Azure Disk CSI driver instead.
azureFile (removed)
The in-tree azureFile driver was removed in Kubernetes v1.30.
Kubernetes redirects all operations for this type to the file.csi.azure.com
CSI driver.
Use the
Azure File CSI driver instead.
cephfs (removed)
The in-tree cephfs driver was removed in Kubernetes v1.31.
A cephfs volume no longer works.
Use the Ceph CSI driver instead.
cinder (removed)
The in-tree cinder driver was removed in Kubernetes v1.26.
Kubernetes redirects all operations for this type to the
cinder.csi.openstack.org CSI driver.
Use the OpenStack Cinder CSI driver instead.
flocker (removed)
The in-tree flocker driver was removed in Kubernetes v1.25.
flocker volumes no longer work.
gcePersistentDisk (removed)
The in-tree gcePersistentDisk driver was removed in Kubernetes v1.28.
Kubernetes redirects all operations for this type to the
pd.csi.storage.gke.io CSI driver.
Use the
Google Compute Engine Persistent Disk CSI driver
instead.
glusterfs (removed)
The in-tree glusterfs driver was removed in Kubernetes v1.26.
glusterfs volumes no longer work.
photonPersistentDisk (removed)
The in-tree photonPersistentDisk driver was removed in Kubernetes v1.16.
photonPersistentDisk volumes no longer work.
portworxVolume (removed)
The in-tree portworxVolume driver was removed in Kubernetes v1.36.
Kubernetes redirects all operations for this type to the pxd.portworx.com
CSI driver.
Use the
Portworx CSI driver
instead.
quobyte (removed)
The in-tree quobyte driver was removed in Kubernetes v1.25.
quobyte volumes no longer work.
Use the Quobyte CSI driver
instead.
rbd (removed)
The in-tree rbd driver was removed in Kubernetes v1.31, together with its
CSI migration support.
rbd volumes no longer work.
Use the Ceph CSI driver instead.
scaleIO (removed)
The in-tree scaleIO driver was removed in Kubernetes v1.22.
scaleIO volumes no longer work.
ScaleIO is now called Dell PowerFlex.
Use the PowerFlex CSI driver instead.
storageos (removed)
The in-tree storageos driver was removed in Kubernetes v1.25.
storageos volumes no longer work.
vsphereVolume (removed)
The in-tree vsphereVolume driver was removed in Kubernetes v1.30.
Kubernetes redirects all operations for this type to the
csi.vsphere.vmware.com CSI driver.
Use the
vSphere CSI driver
instead.