Chapter 9. Request persistent storage for workspaces

Procedure

1. Add a volume component in the devfile:

   ...
   components:
     ...
     - name: <chosen_volume_name>
       volume:
         size: <requested_volume_size>G
     ...

2. Add a volumeMount for the relevant container in the devfile:

   ...
   components:
     - name: ...
       container:
         ...
         volumeMounts:
           - name: <chosen_volume_name_from_previous_step>
             path: <path_where_to_mount_the_PV>
         ...

   For example, when a workspace is started with the following devfile, the cache PV is provisioned to the golang container in the /.cache container path:

   schemaVersion: 2.1.0
   metadata:
     name: mydevfile
   components:
     - name: golang
       container:
         image: golang
         memoryLimit: 512Mi
         mountSources: true
         command: ['sleep', 'infinity']
         volumeMounts:
           - name: cache
             path: /.cache
     - name: cache
       volume:
         size: 2Gi

Procedure

1. Add the controller.devfile.io/mount-to-devworkspace: true label to the PVC.

   $ oc label persistentvolumeclaim <PVC_name> \
             controller.devfile.io/mount-to-devworkspace=true

2. Optional: Use the annotations to configure how the PVC is mounted:

   Expand

   Table 9.1. Optional annotations

   Annotation	Description
   controller.devfile.io/mount-path:	The mount path for the PVC. Defaults to /tmp/<PVC_name>.
   controller.devfile.io/read-only:	Set to 'true' or 'false' to specify whether the PVC is to be mounted as read-only. Defaults to 'false', resulting in the PVC mounted as read/write.

   Show more

   For example, to mount a read-only PVC:

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: <pvc_name>
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
     annotations:
       controller.devfile.io/mount-path: </example/directory>
       controller.devfile.io/read-only: 'true'
   spec:
     accessModes:
       - ReadWriteOnce
     resources:
       requests:
         storage: 3Gi
     storageClassName: <storage_class_name>
     volumeMode: Filesystem

   where:

   </example/directory>

   The mounted PV is available at this path in the workspace.

   3Gi

   Example size value of the requested storage.

   <storage_class_name>

   The name of the StorageClass required by the claim. Remove this line if you want to use a default StorageClass.