Using volumes to persist container data - Worki... https://docs.openshift.com/container-platform/4...

(/)
PRODUCTS  LEARN  COMMUNITY  SUPPORT  FREE TRIAL (HTTPS://WWW.OPENSHIFT.COM/TRIAL/) LOG IN

Documentation (/)
/  OpenShift Container Platform (https://docs.openshift.com/container-platform/4.1/welcome
/index.html) 4.1
/  Nodes /  Working with containers (../../nodes/containers/nodes-containers-using.html)
/  Using volumes to persist container data
Page history (https://github.com/openshift/openshift-docs/commits/enterprise-4.1/nodes
/containers/nodes-containers-volumes.adoc) / Suggest an edit (https://github.com/openshift
/openshift-docs/issues/new?title=[enterprise-4.1] Edit suggested in file nodes/containers/nodes-
containers-volumes.adoc)

Using volumes to persist container data

Understanding volumes
Working with volumes using the OpenShift Container
Platform CLI
Listing volumes and volume mounts in a pod
Adding volumes to a pod
Updating volumes and volume mounts in a pod
Removing volumes and volume mounts from a pod
Configuring volumes for multiple uses in a pod

Files in a container are ephemeral. As such, when a container crashes

or stops, the data is lost. You can use volumes to persist the data used
by the containers in a pod. A volume is directory, accessible to the
Containers in a Pod, where data is stored for the life of the pod.

Understanding volumes
Volumes are mounted file systems available to pods and their
containers which may be backed by a number of host-local or network
attached storage endpoints. Containers are not persistent by default;
on restart, their contents are cleared.

To ensure that the file system on the volume contains no errors and, if
errors are present, to repair them when possible, OpenShift Container
Platform invokes the fsck utility prior to the mount utility. This occurs
when either adding a volume or updating an existing volume.

The simplest volume type is emptyDir, which is a temporary directory

on a single machine. Administrators may also allow you to request a
persistent volume that is automatically attached to your pods.

emptyDir volume storage may be restricted by a quota based on

 the pod’s FSGroup, if the FSGroup parameter is enabled by your

cluster administrator.

Working with volumes using the

OpenShift Container Platform CLI
You can use the CLI command oc set volume to add and remove
volumes and volume mounts for any object that has a pod template
like replication controllers or DeploymentConfigs. You can also list
volumes in pods or any object that has a pod template.

The oc set volume command uses the following general syntax:

$ oc set volume <object_selection> <operation> <mandatory_parameters> <options>

Object selection
Specify one of the following for object_seletion in the
oc set volume command:

Table 1. Object Selection

Syntax Description Example

<object_type> Copyright Selects

<name> © 2019 Red<name>
Hat, Inc. deploymentConfig registry
Privacy statement (https://www.redhat.com/en/about/privacy-
of type
policy) Terms of use (https://www.openshift.com/legal/terms/)
<object_type>.
1 of 5 All policies and guidelines (https://www.redhat.com/en/about/all-policies-guidelines) 10/17/19, 8:35 AM
Using volumes to persist container data - Worki... https://docs.openshift.com/container-platform/4...
Syntax Description Example

<object_type>/<name> Selects <name> deploymentConfig/registry

of type
<object_type>.

<object_type> Selects deploymentConfig

--selector= resources of --selector="name=registry"
<object_label_selector> type
<object_type>
that matched
the given label
selector.

<object_type> --all Selects all deploymentConfig --all

resources of
type
<object_type>.

-f or --filename= File name, -f registry-deployment-

<file_name> directory, or config.json
URL to file to
use to edit the
resource.

Operation
Specify --add, --remove, or --list for operation in the
oc set volume command.

Mandatory parameters
Any <mandatory_parameters> are specific to the selected operation
and are discussed in later sections.

Options
Any <options> are specific to the selected operation and are
discussed in later sections.

Listing volumes and volume mounts in a

pod
You can list volumes and volume mounts in pods or pod templates:

Procedure
To list volumes:

$ oc set volume <object_type>/<name> --list [options]

List volume supported options:

Option Description Default

--name Name of the volume.

-c, --containers Select containers by '*'

name. It can also take
wildcard '*' that
matches any character.

For example:

To list all volumes for pod p1:

$ oc set volume pod/p1 --list

To list volume v1 defined on all DeploymentConfigs:

$ oc set volume dc --all --name=v1

Adding volumes to a pod

You can add volumes and volume mounts to a pod.

2 of 5 Procedure 10/17/19, 8:35 AM

Using volumes to persist container data - Worki... https://docs.openshift.com/container-platform/4...
To add a volume, a volume mount, or both to pod templates:

$ oc set volume <object_type>/<name> --add [options]

Table 2. Supported Options for Adding Volumes

Option Description Default

--name Name of the volume. Automatically

generated, if not
specified.

-t, --type Name of the volume source. emptyDir

Supported values: emptyDir,
hostPath, secret, configmap,
persistentVolumeClaim or
projected.

-c, --containers Select containers by name. It can '*'

also take wildcard '*' that
matches any character.

-m, --mount-path Mount path inside the selected

containers.

--path Host path. Mandatory parameter

for --type=hostPath.

--secret-name Name of the secret. Mandatory

parameter for --type=secret.

--configmap-name Name of the configmap.

Mandatory parameter for
--type=configmap.

--claim-name Name of the persistent volume

claim. Mandatory parameter for
--type=persistentVolumeClaim.

--source Details of volume source as a

JSON string. Recommended if the
desired volume source is not
supported by --type.

-o, --output Display the modified objects

instead of updating them on the
server. Supported values: json,
yaml.

--output-version Output the modified objects with api-version

the given version.

For example:

To add a new volume source emptyDir to DeploymentConfig

registry:

$ oc set volume dc/registry --add

To add volume v1 with secret $ecret for replication controller r1

and mount inside the containers at /data:

$ oc set volume rc/r1 --add --name=v1 --type=secret --secret-name='$ecret'

To add existing persistent volume v1 with claim name pvc1 to

deployment configuration dc.json on disk, mount the volume on
container c1 at /data, and update the DeploymentConfig on the
server:

$ oc set volume -f dc.json --add --name=v1 --type=persistentVolumeClaim \

--claim-name=pvc1 --mount-path=/data --containers=c1

To add a volume v1 based on Git repository https://github.com

3 of 5 /namespace1/project1 with revision 5125c45f9f563 for all 10/17/19, 8:35 AM
Using volumes to persist container data - Worki... https://docs.openshift.com/container-platform/4...
replication controllers:

$ oc set volume rc --all --add --name=v1 \

--source='{"gitRepo": {
"repository": "https://github.com/namespace1/project1",
"revision": "5125c45f9f563"
}}'

Updating volumes and volume mounts in

a pod
You can modify the volumes and volume mounts in a pod.

Procedure
Updating existing volumes using the --overwrite option:

$ oc set volume <object_type>/<name> --add --overwrite [options]

For example:

To replace existing volume v1 for replication controller r1 with

existing persistent volume claim pvc1:

$ oc set volume rc/r1 --add --overwrite --name=v1 --type=persistentVolumeC

To change DeploymentConfig d1 mount point to /opt for volume

v1:

$ oc set volume dc/d1 --add --overwrite --name=v1 --mount-path=/opt

Removing volumes and volume mounts

from a pod
You can remove a volume or volume mount from a pod.

Procedure
To remove a volume from pod templates:

$ oc set volume <object_type>/<name> --remove [options]

Table 3. Supported Options for Removing Volumes

Option Description Default

--name Name of the volume.

-c, --containers Select containers by '*'

name. It can also take
wildcard '*' that
matches any character.

--confirm Indicate that you want to

remove multiple volumes
at once.

-o, --output Display the modified

objects instead of
updating them on the
server. Supported
values: json, yaml.

--output-version Output the modified api-version

objects with the given
version.

For example:

4 of 5 To remove a volume v1 from DeploymentConfig d1: 10/17/19, 8:35 AM

Using volumes to persist container data - Worki... https://docs.openshift.com/container-platform/4...

$ oc set volume dc/d1 --remove --name=v1

To unmount volume v1 from container c1 for DeploymentConfig

d1 and remove the volume v1 if it is not referenced by any
containers on d1:

$ oc set volume dc/d1 --remove --name=v1 --containers=c1

To remove all volumes for replication controller r1:

$ oc set volume rc/r1 --remove --confirm

Configuring volumes for multiple uses in

a pod
You can configure a volume to allows you to share one volume for
multiple uses in a single pod using the volumeMounts.subPath
property to specify a subPath inside a volume instead of the volume’s
root. `` .Procedure

1. View the list of files in the volume, run the oc rsh command:

$ oc rsh <pod>
sh-4.2$ ls /path/to/volume/subpath/mount
example_file1 example_file2 example_file3

2. Specify the subPath:

Example subPath Usage

apiVersion: v1
kind: Pod
metadata:
name: my-site
spec:
containers:
- name: mysql
image: mysql
volumeMounts:
- mountPath: /var/lib/mysql
name: site-data
subPath: mysql 1
- name: php
image: php
volumeMounts:
- mountPath: /var/www/html
name: site-data
subPath: html 2
volumes:
- name: site-data
persistentVolumeClaim:
claimName: my-site-data

1 Databases are stored in the mysql folder.

2 HTML content is stored in the html folder.

5 of 5 10/17/19, 8:35 AM