Kubernetes Mounting Volumes in Pods: Difference between revisions
| Line 19: | Line 19: | ||
[[#mountPath|mountPath]]: '/red' | [[#mountPath|mountPath]]: '/red' | ||
[[#subPath|subPath]]: 'orange' | [[#subPath|subPath]]: 'orange' | ||
This configuration specifies that the file system exposed by the volume "mount-0" will be mounted inside the container's filesystem as /red. Only a part of the volume "mount-0" filesystem will be exposed, and that is the content of its "/orange" subdirectory. | |||
==<span id='volume_name'></span><tt>name</tt>== | ==<span id='volume_name'></span><tt>name</tt>== | ||
The identifier of the volume. Must match the name the volume specification was declared under, in the [[Kubernetes_Pod_Manifest#volumes|volumes]] section of the specification. Is the same volume is used for multiple mount points, those mount points should refer the same volume name. | The identifier of the volume. Must match the name the volume specification was declared under, in the [[Kubernetes_Pod_Manifest#volumes|volumes]] section of the specification. Is the same volume is used for multiple mount points, those mount points should refer the same volume name. | ||
Revision as of 03:48, 3 January 2021
External
Internal
Overview
Specifies how the volumes declared in the volumes section of the manifest are to be mounted (projected) into the container's filesystem. The volumeMounts element contains an array of volume mounts. Each volume mount specifies the volume name and mount details, such as the container filesystem mount path and optionally a subpath inside the external volume, relative to its root. Mounting the same volume (specified by its name) multiple times, as part of different volume mounts with different mount characteristics, such different mount points, subPaths, etc. is permitted.
volumeMounts Pod Manifest Section
kind: Pod
spec:
containers:
- name: 'test'
...
volumeMounts:
- name: 'mount-0'
mountPath: '/red'
subPath: 'orange'
This configuration specifies that the file system exposed by the volume "mount-0" will be mounted inside the container's filesystem as /red. Only a part of the volume "mount-0" filesystem will be exposed, and that is the content of its "/orange" subdirectory.
name
The identifier of the volume. Must match the name the volume specification was declared under, in the volumes section of the specification. Is the same volume is used for multiple mount points, those mount points should refer the same volume name.
mountPath
Specifies the path within the container where the volume will be mounted. Must not contain ':'.
The mount will succeed even if some or all intermediate path elements of the "mountPath" does not exist as directories in the container's file system - they will be created as necessary.
subPath
Specifies the relative path within the external volume, relative to the root of the external volume, whose content will be mounted as container's volume. If the path does not exist on the external volume, it will be created. If not specified, defaults to "" (external volume's root). subPath value must be a relative, the metadata will cause a deployment error if "/" or a path that starts with "/" is used.
Specifying:
subPath: ''
is a noop - the metadata will be accepted as correct, and the external volume's root will be mounted.
subPathExpr
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to subPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). subPathExpr and subPath are mutually exclusive.
readOnly
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
Use Cases
- Storage
- Secrets projected as files