Kubernetes Mounting Volumes in Pods: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 10: Line 10:


<font color=darkgray>TODO consolidate with [[Kubernetes_Pod_Manifest#volumeMounts|Pod Manifest - volumeMounts]]</font>.
<font color=darkgray>TODO consolidate with [[Kubernetes_Pod_Manifest#volumeMounts|Pod Manifest - volumeMounts]]</font>.
=<tt>volumeMounts</tt> Pod Manifest Section=
{{External|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.16/#volumemount-v1-core}}
Specifies how the volumes declared in the [[#volumes_manifest|volumes section of the manifest]] are to be mounted (projected) into the container's filesystem.
Also see: {{Internal|Kubernetes_Storage_Concepts#Mounting_a_Volume_in_Pod|Mounting a Volume in a Pod}}
====<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 [[#volumes|volumes]] section of the specification.
If we need to use the same volume for multiple mount points, those mount points should refer the same volume name.
====<tt>mountPath</tt>====
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.
====<tt>subPath</tt>====
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). <code>subPath</code> value must be a relative, the metadata will cause a deployment error if "/" or a path that starts with "/" is used.
Specifying:
<syntaxhighlight lang='yaml'>
  subPath: ''
</syntaxhighlight>
is a noop - the metadata will be accepted as correct, and the external volume's root will be mounted.
====<tt>subPathExpr</tt>====
Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to [[#subPath|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.
====<tt>readOnly</tt>====
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
====Use Cases====
* Storage
* [[Kubernetes_Secrets_Operations#Consume_a_Secret_as_a_File|Secrets projected as files]]

Revision as of 21:44, 2 January 2021

External

Internal

Overview

Mounting the same volume (specified by its name) multiple time, with different mount characteristics, such different mount points, subPaths, etc. is permitted.

TODO consolidate with Pod Manifest - volumeMounts.

volumeMounts Pod Manifest Section

https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.16/#volumemount-v1-core

Specifies how the volumes declared in the volumes section of the manifest are to be mounted (projected) into the container's filesystem.

Also see:

Mounting a Volume in a Pod

name

The identifier of the volume. Must match the name the volume specification was declared under, in the volumes section of the specification.

If we need to use the same volume 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

Retrieved from "https://kb.novaordis.com/index.php?title=Kubernetes_Mounting_Volumes_in_Pods&oldid=74853"