Kubernetes Mounting Volumes in Pods: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
No edit summary
Line 18: Line 18:
       - [[#volume_name|name]]: 'mount-0'
       - [[#volume_name|name]]: 'mount-0'
         [[#mountPath|mountPath]]: '/red'
         [[#mountPath|mountPath]]: '/red'
        # 'orange' must exist in the root of the volume identified by 'mount-0'; the content of that
        # directory will be exposed in the container under the '/red' directory.
         [[#subPath|subPath]]: 'orange'  
         [[#subPath|subPath]]: 'orange'  
==<span id='volume_name'></span><tt>name</tt>==
==<span id='volume_name'></span><tt>name</tt>==

Revision as of 03:44, 3 January 2021

External

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

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 specifying the volume name and mount details. 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'

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

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